| | | |
| Component | | fm_cust |
| | | |
| Visibility | | public |
| | | |
| Transaction | | required |
The pcmOpCustModifyCustomer operation can be used to modify customer
information. This operations helps to add account and service level deals,
add new services and purchase deals to those services and also to add
and/or update balance groups, billinfo's, payinfo's and profiles.
| | | |
| Use | | required |
| | | |
| Class | | /plan |
| | | |
| Class | | /account |
The poid of the chosen addon plan or account to be modified.
| | | |
| Use | | required |
| | | |
| Class | | /account |
The poid of account object to be modified.
This field represents the timestamp at which the event ends. This also
represents the effective time of update to this account, on an external
system. If this field is not specified, then current time on the Oracle Monetization Cloud
server will be considered.
This would be the timestamp to be used to generate events. If not
specified, the current time on the Oracle Monetization Cloud server will be considered.
| | |
| 0 | string
PROGRAM_NAME | In Out |
The name of the program that executed this operation.
| | | |
| Use | | optional |
| | | |
| ElemID mode | | index |
| | | |
| Iteration | | undefined |
| | | |
| Min number of Elements | | 0 |
| | | |
| Allow ELEMID_ANY | | false |
Information to be stored in the account object will be passed in the
acctinfo.
Account level deal to purchase (if any).
| | |
| 1 | substruct
DEAL_INFO | In Out |
Deal to be purchased at account level. The DEAL_INFO and
PIN_FLD_DEAL_OBJ are mutually exclusive. Sometimes we may purchase
the deal customized. So, the DEAL_INFO has the entire deal object
(the products and discounts in the deal should be passed) in the
PIN_FLD_DEAL_INFO sub-structure.
Name of the deal object. Present only if a customized deal is to be
purchased.
Deal description. This is a free text to describe product. Present
only if a customized deal is to be purchased.
Valid start time. Defines valid period for the deal object
(inclusive). Stored as desired time in server timezone. Present
only if a customized deal is to be purchased.
Valid end time. Defines valid period for the deal object
(non-inclusive). Stored as desired time in server timezone. If end
time is zero, valid period does not expire. Present only if a
customized deal is to be purchased.
Flag to indicate on demand bill at the deal level and has value
PIN_DEAL_FLG_BILL_ON_DEMAND for on demand billing. Present only if
a customized deal is to be purchased.
Products Array. Array of products to purchase for the deal. Present
only if a customized deal is to be purchased.
Poid of the product to purchase.
Poid of plan through which product is being purchased.
Quantity to purchase.
| |
| 0 | NOT_SET |
| |
| 1 | ACTIVE |
| |
| 2 | INACTIVE |
| |
| 3 | CANCELLED |
Status of this subscription product. Possible values are
NOT_SET(0)
ACTIVE(1)
INACTIVE(2)
CANCELLED(3)
| | |
| 3 | timestamp
PURCHASE_START_T | In Out |
Purchase start time. Number of seconds into the future relative
to purchase time that product activates (0 means immediately).
| | |
| 3 | int
PURCHASE_START_UNIT | In Out |
For first usage start, the start_unit will be -1. The start date can
be specified in relative units, if it is not set for first usage. The
values can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 3 | int
PURCHASE_START_OFFSET | In Out |
For first usage start, the start_offset will be 0 and relative
offset can be specified for purchase if first usage option is not
marked. To be used in conjunction with unit to calculate
purchase_start_t with reference to the event time.
| | |
| 3 | timestamp
PURCHASE_END_T | In Out |
Purchase end time. Number of seconds into the future relative to
purchase time that product expires (0 means that product does not
expire).
| | |
| 3 | int
PURCHASE_END_UNIT | In Out |
Relative Unit for Purchase can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 3 | int
PURCHASE_END_OFFSET | In Out |
Relative offset for Purchase to be used in conjunction with unit
to calculate purchase end_t.
| | |
| 3 | decimal
PURCHASE_DISCOUNT | In Out |
Purchase discount. The percentage discount applied to
purchase/cancel rates of product.
| | |
| 3 | decimal
PURCHASE_DISC_AMT | In Out |
Fixed amount discount for purchase fees amount of discount
applied to purchase/cancel rates of product.
| | |
| 3 | decimal
PURCHASE_FEE_AMT | In Out |
Purchase fee to be applied for this product. Amount specified
here will override the price specified in the /rate object.
The value of
STATUS_FLAGS should also be set to
PIN_PROD_STATUS_FLAGS_OVERRIDE_PURCHASE_FEE.
| | |
| 3 | timestamp
CYCLE_START_T | In Out |
Cycle fee start time. Number of seconds into the future relative
to purchase time that cycle fees begin for this product (0 means
immediately).
| | |
| 3 | int
CYCLE_START_UNIT | In Out |
For first usage start, the start_unit will be -1. The start date can
be specified in relative units if it is not set for first usage. The
values can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 3 | int
CYCLE_START_OFFSET | In Out |
For first usage start, the start_offset will be 0 and relative
offset can be specified for cycle if first usage option is not
marked. To be used in conjunction with unit to calculate
cycle_start_t with reference to the event time.
| | |
| 3 | timestamp
CYCLE_END_T | In Out |
Cycle fee end time. Number of seconds into the future relative to
purchase time that cycle fees are no longer applied for this
product (0 means always applied).
| | |
| 3 | int
CYCLE_END_UNIT | In Out |
Relative Unit for Cycle can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 3 | int
CYCLE_END_OFFSET | In Out |
Relative offset for Cycle to be used in conjunction with unit to
calculate cycle end_t.
| | |
| 3 | decimal
CYCLE_DISCOUNT | In Out |
Cycle fee discount. The percent discount applied to cycle rates
of product.
| | |
| 3 | decimal
CYCLE_DISC_AMT | In Out |
Fixed amount discount applied to cycle rates of product.
| | |
| 3 | decimal
CYCLE_FEE_AMT | In Out |
Cycle fee (both forward and arrears) to be applied for this
product. Amount specified here will override the price specified
in the /rate object.The value of
STATUS_FLAGS should also be set to PIN_PROD_STATUS_FLAGS_OVERRIDE_CYCLE_FEE.
Status flags used in conjunction with the override prices
specified in
PURCHASE_FEE_AMT and
CYCLE_FEE_AMT. The possible values are: -
PIN_PROD_STATUS_FLAGS_OVERRIDE_PURCHASE_FEE(0x01000000)
PIN_PROD_STATUS_FLAGS_OVERRIDE_CYCLE_FEE(0x02000000)
| | |
| 3 | timestamp
USAGE_START_T | In Out |
Usage fee start time. Number of seconds into the future relative
to purchase time that usage fees begin for this product (0 means
immediately).
| | |
| 3 | int
USAGE_START_UNIT | In Out |
For first usage start, this field is -1. Otherwise the start date is
a relative offset, with the unit specified in this field as:
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 3 | int
USAGE_START_OFFSET | In Out |
For first usage, this field is 0. Otherwise, the start date is a
relative offset, which is specified by a combination of this
field and the start unit field.
| | |
| 3 | timestamp
USAGE_END_T | In Out |
Usage fee end time. Number ofseconds into the future relative to
purchase time that usage fees are no longer applied for this
product (0 means always applied).
| | |
| 3 | int
USAGE_END_UNIT | In Out |
Relative unit for Usage can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 3 | int
USAGE_END_OFFSET | In Out |
Relative offset for usage to be used in conjunction with unit to
calculate usage end_t.
| | |
| 3 | decimal
USAGE_DISCOUNT | In Out |
Usage fee discount. The percent discount applied to usage rates
of product.
Description on a per product basis for CSR to add comments.
| | |
| 3 | string
PRICE_LIST_NAME | In Out |
Price list name associated with this offering.
Discounts Array. Array of discounts to purchase for the deal.
Element-id is not significant. Present only if a customized deal is
to be purchased.
Poid of discount to purchase.
Poid of plan through which discount is being purchased.
Quantity to purchase.
| |
| 0 | NOT_SET |
| |
| 1 | ACTIVE |
| |
| 2 | INACTIVE |
| |
| 3 | CANCELLED |
Status of this subscription discount. Possible values are
NOT_SET(0)
ACTIVE(1)
INACTIVE(2)
CANCELLED(3)
For later use.
| | |
| 3 | timestamp
PURCHASE_START_T | In Out |
Purchase start time. Number of seconds into the future relative
to purchase time that discount activates.
| | |
| 3 | int
PURCHASE_START_UNIT | In Out |
For first usage start, the start_unit will be -1. The start date can
be specified in relative units if it is not set for first usage. The
values can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 3 | int
PURCHASE_START_OFFSET | In Out |
For first usage start, the start_offset will be 0 and relative
offset can be specified for purchase, if first usage option is
not marked. To be used in conjunction with unit to calculate
purchase_start_t with reference to the event time.
| | |
| 3 | timestamp
PURCHASE_END_T | In Out |
Purchase end time. Number of seconds into the future relative to
purchase time that discount expires (0 means that discount does
not expire).
| | |
| 3 | int
PURCHASE_END_UNIT | In Out |
Relative Unit for Purchase can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 3 | int
PURCHASE_END_OFFSET | In Out |
Relative offset for Purchase to be used in conjunction with unit
to calculate purchase end_t.
| | |
| 3 | timestamp
CYCLE_START_T | In Out |
Cycle fee start time. Number of seconds into the future relative
to purchase time that cycle fees begin for this discount (0 means
immediately).
| | |
| 3 | int
CYCLE_START_UNIT | In Out |
For first usage start, the start_unit will be -1. The start date can
be specified in relative units if it is not set for first usage. The
values can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 3 | int
CYCLE_START_OFFSET | In Out |
For first usage start, the start_offset will be 0 and relative
offset can be specified for purchase, if first usage option is
not marked. To be used in conjunction with unit to calculate
cycle_start_t with reference to the event time.
| | |
| 3 | timestamp
CYCLE_END_T | In Out |
Cycle fee end time. Number of seconds into the future relative to
purchase time that cycle fees are no longer applied for this
discount (0 means always applied).
| | |
| 3 | int
CYCLE_END_UNIT | In Out |
Relative unit for Cycle can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 3 | int
CYCLE_END_OFFSET | In Out |
Relative offset for Cycle to be used in conjunction with unit to
calculate Cycle end_t.
| | |
| 3 | timestamp
USAGE_START_T | In Out |
Usage fee start time. Number of seconds into the future relative
to purchase time that usage fees begin for this discount (0 means
immediately).
| | |
| 3 | int
USAGE_START_UNIT | In Out |
For first usage start, this field is -1. Otherwise the start date is
a relative offset, with the unit specified in this field as:
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 3 | int
USAGE_START_OFFSET | In Out |
For first usage, this field is 0. Otherwise, the start date is a
relative offset, which is specified by a combination of this
field and the start unit field.
| | |
| 3 | timestamp
USAGE_END_T | In Out |
Usage fee end time. Number of seconds into the future relative to
purchase time that usage fees are no longer applied for this
discount (0 means always applied).
| | |
| 3 | int
USAGE_END_UNIT | In Out |
Relative unit for Usage can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 3 | int
USAGE_END_OFFSET | In Out |
Relative offset for Usage to be used in conjunction with unit to
calculate Usage end_t on First Usage.
Description on a per discount basis for CSR to add comments.
Permitted array. Contains type strings for account and service
object types that are permitted to purchase this deal. Each entry
is implicitly appended with a wildcard for checking, so account and
service types that were inherited from a permitted type are also
permitted themselves. No entries implies any account or service
type is permitted to purchase the deal. Element-id is not
significant.
Object type - identifies an allowed account or service object
type.
| | | |
| Use | | optional |
| | | |
| Parent | | in.ACCTINFO |
| | | |
| ElemID mode | | key |
| | | |
| Iteration | | undefined |
| | | |
| Min number of Elements | | 0 |
| | | |
| Max number of Elements | | 1 |
Account level balance group indicator. Here the array does not
contain anything but the element-id is significant. It indicates
which balance group element in the input is account level. It is
recommended to pass in the PIN_FLD_BAL_INFO. If not passed then a
default balance group will be created.
The partial poid of the balance group to be created. During monitor
creation/update, Poid type of /balance_group/monitor is used.
Balance Group name.
The billinfo array element. Here the contents are not significant.
The element id will determine the billinfo that will be associated
with this balance group. if not specified then the first billinfo
that the system finds will be associated with this balance group.
The type only billinfo poid.
| | |
| 3 | poid
BUSINESS_PROFILE_OBJ | In Out |
Business profile poid. Pointer to the Business profile poid to which
this billinfo belongs.
| | |
| 3 | string
BILLINFO_ID | In Out |
This field identifies the billinfo by name.
The Payinfo array. The element-id is significant, but not the
contents. The element-id will be used to identify which payinfo array
to use from the input. If it is not present then the payment method
is considered either as transient or voucher.
The partial poid of payinfo.
| |
| 10001 | Indicates invoice type(PIN_PAY_TYPE_INVOICE). |
| |
| 10003 | Indicates credit card type(PIN_PAY_TYPE_CC). |
| |
| 10005 | Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD). |
| |
| 10007 | Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD). |
| |
| 10018 | Indicates SEPA payment type(PIN_PAY_TYPE_SEPA). |
This represents the type of billing for user.
Payment term ID defines which payment term will be used in the
payment due date calculation.
| | |
| 4 | int
PAYMENT_OFFSET | In Out |
Payment offset value.
| |
| 0x01 | Indicates detail invoice(PIN_INV_TYPE_DETAIL). |
| |
| 0x02 | Indicates summary invoice(PIN_INV_TYPE_SUMMARY). |
| |
| 0x04 | Indicates regular invoice(PIN_INV_TYPE_REGULAR). |
| |
| 0x08 | Indicates subordinate invoice(PIN_INV_TYPE_SUBORDINATE). |
| |
| 0x10 | Indicates parent invoice(PIN_INV_TYPE_PARENT). |
| |
| 0x18 | Indicates parent with subordinates invoice
(PIN_INV_TYPE_PARENT_WITH_SUBORDS). |
| |
| 0x20 | Indicates hierarchy invoice(PIN_INV_TYPE_HIERARCHY). |
| |
| 0x40 | Indicates trial invoice(PIN_INV_TYPE_TRIAL_INVOICE). |
Indicates the type of invoice to be generated.
Partial Flag. This enables the operation to treat some fields
from the request as optional. Values are (0) mandatory,
or (1) optional. The fields affected are:
PIN_FLD_DEBIT_NUM, PIN_FLD_DEBIT_EXP, PIN_FLD_BANK_NO,
PIN_FLD_CITY, PIN_FLD_STATE, PIN_FLD_ZIP and PIN_FLD_COUNTRY.
| | |
| 4 | substruct
INHERITED_INFO | In Out |
All subclass fields for the payinfo object are included in this
substruct. The subclass depends on the pay_type. If pay_type is
invoice then this array element will have PIN_FLD_INV_INFO, etc.
This array element has fields related to invoice type of payment
menthod. There will be only one element and element id is not
significant.
Street address.
City.
Country.
| | |
| 6 | string
DELIVERY_DESCR | In Out |
Delivery mechanism.
| | |
| 6 | enum
DELIVERY_PREFER | In Out |
| |
| 0 | Indicates email delivery(PIN_INV_EMAIL_DELIVERY). |
| |
| 1 | Indicates mail delivery(PIN_INV_USP_DELIVERY). |
| |
| 3 | Indicates fax delivery(PIN_INV_FAX_DELIVERY). |
Prefered delivery method email(0), postal(1) and fax(3).
Comments to appear on each invoice.
Used for invoice terms to be printed on the invoice.
Email address to which invoice be delivered.
Name of party responsible for payment.
State or province.
Zip/Postal code.
This array element has fields related to credit card type of
payment menthod. There will be only one element and element id is
not significant.
Street Address
City.
Country.
Credit card expiration date (mmyy).
Credit card number.
Name as it appears on the credit card.
| | |
| 6 | string
SECURITY_ID | In Out |
Security ID. Used for credit card fraud prevention. This field
stores the 3 digit CVV2 for Visa and 4 digit CID for amex.
State or province.
Zip/Postal code.
This array element has fields related to direct debit type of
payment menthod. There will be only one element and element id is
not significant.
Street Address.
RDFI/Bank ID used for routing transactions.
City.
Country.
Customer's bank account number.
Name as it appears on the card.
State or province.
| |
| 1 | Checking Account type(PIN_ACCOUNT_TYPE_CHECKING). |
| |
| 2 | Savings Account type(PIN_ACCOUNT_TYPE_SAVINGS). |
| |
| 3 | Corporate Account type(PIN_ACCOUNT_TYPE_CORPORATE). |
Bank account type. Checking(1), savings(2) or corporate(3).
Zip/Postal code.
This array element has fields related to SEPA type of
payment method. There will be only one element and element id is
not significant.
| |
| 0 | One-off mandate. |
| |
| 1 | Recurring mandate. |
Mandate type whether it is one-off or recurring.
International Bank Account Number which
is a unique identifier for the bank account.
Bank Identifier Code which is a unique
identifier for the bank related to the account.
| | |
| 6 | string
MANDATE_CONTRACT_ID | In Out |
ID of the underlying contract between the debtor
and the creditor.
| | |
| 6 | string
MANDATE_CONTRACT_DESCR | In Out |
Description of the underlying contract between the debtor
and the creditor.
| | |
| 6 | string
MANDATE_UNIQUE_REFERENCE | In Out |
A unique reference number for the mandate.
| | |
| 6 | timestamp
MANDATE_SIGNED_T | In Out |
Date when the mandate is signed. This cannot be before the account creation date or a future date.
| | |
| 6 | string
MANDATE_SIGNED_PLACE | In Out |
Place where the mandate is signed.
Array to store SEPA compliant customer's bank account details.
Street address of the contact.
City portion of the address.
Country portion of the address.
Name of the contact.
Zipcode.
| | |
| 7 | string
IDENTIFICATION_CODE | In Out |
Debtor identification code.
Name of the Debtor Reference Party.
| | |
| 7 | string
REF_PARTY_ID_CODE | In Out |
Identification code of the Debtor Reference Party.
| | |
| 6 | string
CREDITOR_ID | In Out |
Identification code of the Creditor.
| | |
| 6 | string
CREDITOR_NAME | In Out |
Name of the Creditor.
The balance group info array. The element-id is significant, but not
the contents. The element-id will be used to identify which balance
group array to use from the input. If it is not present then a
default balance group will be created for the billinfo.
| |
| 10001 | Indicates invoice type(PIN_PAY_TYPE_INVOICE). |
| |
| 10003 | Indicates credit card type(PIN_PAY_TYPE_CC). |
| |
| 10005 | Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD). |
| |
| 10007 | Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD). |
| |
| 10018 | |
| |
| 10101 | . |
This represents the type of billing for user.
This flag indicates if this billinfo has subordinates or not. A value
of 0 indicates no subordinates and a value of 1 indicates that it has
subordinates.
Anniversary billing slot.
| | |
| 3 | int
ACTG_FUTURE_DOM | In Out |
New Accounting Close day-of-month (1-31).
| |
| 1 | This represents "open items" type of accounting. With open item
accounting customer's bill does not include amounts from previous
bill, if not paid(PIN_ACTG_TYPE_OPEN_ITEMS). |
| |
| 2 | This represents "balance forward" type of accounting. With balance
forward accounting customer's bill will include amounts from
previous bill, if not paid(PIN_ACTG_TYPE_BALANCE_FORWARD). |
Accounting type of the billinfo. Possible values are
PIN_ACTG_TYPE_OPEN_ITEMS(1) and PIN_ACTG_TYPE_BALANCE_FORWARD(2).This
field is used to allocate items for payment. If not specified, the
configuration entry actg_type is read from pin.conf of CM. If CM's
pin.conf does not have actg_type entry active, then default
accounting type will be balance forward type.
| | |
| 3 | enum
BILLING_STATUS | In Out |
| |
| 0 | Indicates billing status is active(PIN_BILL_ACTIVE). |
| |
| 1 | Indicates billing status is inactive(PIN_BILL_INACTIVE). |
Indicates whether the billinfo should be billed or it should be
suspended for billing.
| | |
| 3 | int
BILLING_STATUS_FLAGS | In Out |
Indicates a reason for setting of the given billing status.
| |
| 10100 | Indicates an active billinfo(PIN_STATUS_ACTIVE). |
| |
| 10102 | Indicates an inactive billinfo(PIN_STATUS_INACTIVE). |
| |
| 10103 | Indicates a closed billinfo(PIN_STATUS_CLOSED). |
Status of the billinfo: active, inactive, or closed.
Indicates a reason for setting of the given status.
It indicates whether this billinfo has a sponsoree.
| 3 | int
SPONSOREE_FLAGS | In Out |
It indicates whether this billinfo has a sponsor.
| | |
| 3 | poid
AR_BILLINFO_OBJ | In Out |
It indicates the AR billinfo for the given billinfo. It can be
present only for a subodinate billinfo.
| | |
| 3 | poid
PARENT_BILLINFO_OBJ | In Out |
It indicates the immediate (one level up) parent. Note that the given
billinfo is not necessarily a subordinate. The parent field may
reflect just child-parent relation. It should be mandatory if moving
to the new parent.
During account creation these values will be derived from the
account. In future when an account can have multiple currencies, the
value specified here will be used.
| | |
| 3 | int
CURRENCY_SECONDARY | In Out |
During account creation these values will be derived from the
account. In future when an account can have multiple currencies, the
value specified here will be used.
| | |
| 3 | enum
BILLING_SEGMENT | In Out |
It indicates the Billing Segment. A billing segment is a user defined
category such as wholesale or retail, that controls the accounting
DOMs to which a bill unit can be assigned.
The POID of Billinfo that this balance group will be associated with.
The fields PIN_FLD_BILLINFO and PIN_FLD_BILLINFO_OBJ are mutually
exclusive. If PIN_FLD_BILLINFO is available then PIN_FLD_BILLINFO_OBJ
will be ignored.
This an optional array to set the credit limit parameters. The
element id is significant and indicates the resource id for which the
limit is being set.
| | |
| 3 | decimal
CREDIT_LIMIT | In Out |
Limit for this resource. Current balance cannot exceed this limit
unless affected by a limit override rate or manually adjusted by a
CSR.
| | |
| 3 | decimal
CREDIT_FLOOR | In Out |
Baseline for calculating percentage for threshold triggers. Credit
limit minus credit floor is 100% of measured range. Credit floor
does NOT enforce any limit on current balance.
| | |
| 3 | decimal
CREDIT_THRESHOLDS_FIXED | In Out |
Limit for this resource. Current balance cannot exceed this limit
unless affected by a limit override rate or manually adjusted by a
CSR.
| | |
| 3 | int
CREDIT_THRESHOLDS | In Out |
Bit flags for triggering when resource balance crosses a boundary
when increasing in value.
| | | |
| Use | | optional |
| | | |
| Parent | | in.ACCTINFO.BAL_INFO.LIMIT |
| | | |
| ElemID mode | | ignored |
| | | |
| Iteration | | undefined |
| | | |
|
Allow ELEMID_ASSIGN
| | true |
| | | |
| Allow ELEMID_ANY | | true |
| | | |
| Recursive | | false |
Array of fixed threshold values.
Fixed threshold value.
Fixed threshold value in Decimal data type
This is an optional array to set the consumption rules for a
resource. The element id is significant and indicates a resource id
for which the limit as well as consumption rules are set.
| | |
| 3 | enum
CONSUMPTION_RULE | In Out |
| |
| 0 | The consumption rule is not defined
(PIN_CONSUMPTION_RULE_UNDEFINED). |
| |
| 1 | Earliest start time. Consume the sub-balance with the earliest
validity start time (earliest valid_from) first
(PIN_CONSUMPTION_RULE_EST). |
| |
| 2 | Latest start time. Consume the sub-balance with the latest
validity start time (latest valid_from) first
(PIN_CONSUMPTION_RULE_LST). |
| |
| 3 | Earliest expiration time. Consume the sub-balance that expires
first (earliest valid_to.)(PIN_CONSUMPTION_RULE_EET) |
| |
| 4 | Latest expiration time. Consume the sub-balance that expires last
(latest valid_to.)(PIN_CONSUMPTION_RULE_LET) |
| |
| 5 | Earliest start time and latest expiration time. Consume the
sub-balance with the earliest valid_from first. If more than one
sub-balances has the same valid_from, consume the one with the
latest valid_to first(PIN_CONSUMPTION_RULE_ESTLET). |
| |
| 6 | Earliest start time and earliest expiration time. Consume the
sub-balance with the earliest valid_from first. If more than one
sub-balances has the same valid_from, consume the one with the
earliest valid_to first(PIN_CONSUMPTION_RULE_ESTEET). |
| |
| 7 | Latest start time and earliest expiration time. Consume the
sub-balance with the latest sub-balance first. If more than one
sub-balances has the same valid_from, consume the one with the
earliest expired sub-balance first(PIN_CONSUMPTION_RULE_LSTEET).
|
| |
| 8 | Latest start time and latest expiration time. Consume the
sub-balance with the latest valid_from first. If more than one
sub-balances has the same valid_from, consume the one with the
latest valid_to first(PIN_CONSUMPTION_RULE_LSTLET). |
| |
| 9 | Earliest expiration time and earliest start time. Consume the
sub-balance with the earliest valid_to first. If more than one
sub-balances has the same valid_to, consume the one with the
earliest valid_from first(PIN_CONSUMPTION_RULE_EETEST). |
| |
| 10 | Earliest expiration time and latest start time. Consume the
sub-balance with the earliest valid_to first. If more than one
sub-balances has the same valid_to, consume the one with the
latest valid_from first(PIN_CONSUMPTION_RULE_EETLST). |
| |
| 11 | Latest expiration time and earliest start time. Consume the
sub-balance with the latest valid_to first. If more than one
sub-balances has the same valid_to, use the one with the earliest
valid_from first(PIN_CONSUMPTION_RULE_LETEST). |
| |
| 12 | Latest expiration time and latest start time. Consume the
sub-balance with the latest valid_to first. If more than one
sub-balances has the same valid_to, use the one with the latest
valid_from first(PIN_CONSUMPTION_RULE_LETLST). |
Consumption rule to be applied on the resource.
The balance group object for the account. Either PIN_FLD_BAL_INFO or
PIN_FLD_BAL_GRP_OBJ must be specified. If PIN_FLD_BAL_INFO is passed
in, this field will be ignored.
The primary currency of the account. Also this acts as element-id of
primary balance element for accounting roll-up. If not provided the
default account currency information will be read from CM's pin.conf.
| | |
| 1 | int
CURRENCY_SECONDARY | In Out |
The secondary currency of the account. Also this acts as element-id
of secondary balance element for accounting roll-up.
| | | |
| Use | | optional |
| | | |
| ElemID mode | | ignored |
| | | |
| Iteration | | undefined |
| | | |
| Min number of Elements | | 0 |
This represents services array.
| | | |
| Use | | required |
| | | |
| Parent | | in.SERVICES |
| | | |
| Mode | | typeonly |
| | | |
| Class | | /service |
Partial poid of service object to create. The 'type' and 'database'
sub-fields are used in the creation. The other sub-fields are ignored.
| | |
| 1 | int
SUBSCRIPTION_INDEX | In Out |
If this is a member service of a line/subscription, the index points
to the parent/subscription service of the line. The member service
object, when created, will refer the parent/subscription service
using the SUBSCRIPTION_OBJ field. For all other services, the default
is 0.
| | |
| 1 | poid
SUBSCRIPTION_OBJ | In Out |
Subscription service object type only POID. This is an optional
field, and it refers to the subscription service object of which this
service is a member of.
User defined name for the service. This identifies the service
uniquely within the plan.
| | | |
| Use | | optional |
| | | |
| Parent | | in.SERVICES |
| | | |
| ElemID mode | | key |
| | | |
| Min number of Elements | | 0 |
| | | |
| Max number of Elements | | 1 |
Balance Group array which this service instance is associated to. The
element-id is significant not the contents of the array. The
element-id will be used to identify which balance group array to use
from the input to associate the service to. if not specified the
service will be associated with the account level balance group.
The partial poid of the balance group to be created. During monitor
creation/update, Poid type of /balance_group/monitor is used.
Balance Group name.
The billinfo array element. Here the contents are not significant.
The element id will determine the billinfo that will be associated
with this balance group. if not specified then the first billinfo
that the system finds will be associated with this balance group.
The type only billinfo poid.
| | |
| 3 | poid
BUSINESS_PROFILE_OBJ | In Out |
Business profile poid. Pointer to the Business profile poid to which
this billinfo belongs.
| | |
| 3 | string
BILLINFO_ID | In Out |
This field identifies the billinfo by name.
The Payinfo array. The element-id is significant, but not the
contents. The element-id will be used to identify which payinfo array
to use from the input. If it is not present then the payment method
is considered either as transient or voucher.
The partial poid of payinfo.
| |
| 10001 | Indicates invoice type(PIN_PAY_TYPE_INVOICE). |
| |
| 10003 | Indicates credit card type(PIN_PAY_TYPE_CC). |
| |
| 10005 | Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD). |
| |
| 10007 | Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD). |
| |
| 10018 | Indicates SEPA payment type(PIN_PAY_TYPE_SEPA). |
This represents the type of billing for user.
Payment term ID defines which payment term will be used in the
payment due date calculation.
| | |
| 4 | int
PAYMENT_OFFSET | In Out |
Payment offset value.
| |
| 0x01 | Indicates detail invoice(PIN_INV_TYPE_DETAIL). |
| |
| 0x02 | Indicates summary invoice(PIN_INV_TYPE_SUMMARY). |
| |
| 0x04 | Indicates regular invoice(PIN_INV_TYPE_REGULAR). |
| |
| 0x08 | Indicates subordinate invoice(PIN_INV_TYPE_SUBORDINATE). |
| |
| 0x10 | Indicates parent invoice(PIN_INV_TYPE_PARENT). |
| |
| 0x18 | Indicates parent with subordinates invoice
(PIN_INV_TYPE_PARENT_WITH_SUBORDS). |
| |
| 0x20 | Indicates hierarchy invoice(PIN_INV_TYPE_HIERARCHY). |
| |
| 0x40 | Indicates trial invoice(PIN_INV_TYPE_TRIAL_INVOICE). |
Indicates the type of invoice to be generated.
Partial Flag. This enables the operation to treat some fields
from the request as optional. Values are (0) mandatory,
or (1) optional. The fields affected are:
PIN_FLD_DEBIT_NUM, PIN_FLD_DEBIT_EXP, PIN_FLD_BANK_NO,
PIN_FLD_CITY, PIN_FLD_STATE, PIN_FLD_ZIP and PIN_FLD_COUNTRY.
| | |
| 4 | substruct
INHERITED_INFO | In Out |
All subclass fields for the payinfo object are included in this
substruct. The subclass depends on the pay_type. If pay_type is
invoice then this array element will have PIN_FLD_INV_INFO, etc.
This array element has fields related to invoice type of payment
menthod. There will be only one element and element id is not
significant.
Street address.
City.
Country.
| | |
| 6 | string
DELIVERY_DESCR | In Out |
Delivery mechanism.
| | |
| 6 | enum
DELIVERY_PREFER | In Out |
| |
| 0 | Indicates email delivery(PIN_INV_EMAIL_DELIVERY). |
| |
| 1 | Indicates mail delivery(PIN_INV_USP_DELIVERY). |
| |
| 3 | Indicates fax delivery(PIN_INV_FAX_DELIVERY). |
Prefered delivery method email(0), postal(1) and fax(3).
Comments to appear on each invoice.
Used for invoice terms to be printed on the invoice.
Email address to which invoice be delivered.
Name of party responsible for payment.
State or province.
Zip/Postal code.
This array element has fields related to credit card type of
payment menthod. There will be only one element and element id is
not significant.
Street Address
City.
Country.
Credit card expiration date (mmyy).
Credit card number.
Name as it appears on the credit card.
| | |
| 6 | string
SECURITY_ID | In Out |
Security ID. Used for credit card fraud prevention. This field
stores the 3 digit CVV2 for Visa and 4 digit CID for amex.
State or province.
Zip/Postal code.
This array element has fields related to direct debit type of
payment menthod. There will be only one element and element id is
not significant.
Street Address.
RDFI/Bank ID used for routing transactions.
City.
Country.
Customer's bank account number.
Name as it appears on the card.
State or province.
| |
| 1 | Checking Account type(PIN_ACCOUNT_TYPE_CHECKING). |
| |
| 2 | Savings Account type(PIN_ACCOUNT_TYPE_SAVINGS). |
| |
| 3 | Corporate Account type(PIN_ACCOUNT_TYPE_CORPORATE). |
Bank account type. Checking(1), savings(2) or corporate(3).
Zip/Postal code.
This array element has fields related to SEPA type of
payment method. There will be only one element and element id is
not significant.
| |
| 0 | One-off mandate. |
| |
| 1 | Recurring mandate. |
Mandate type whether it is one-off or recurring.
International Bank Account Number which
is a unique identifier for the bank account.
Bank Identifier Code which is a unique
identifier for the bank related to the account.
| | |
| 6 | string
MANDATE_CONTRACT_ID | In Out |
ID of the underlying contract between the debtor
and the creditor.
| | |
| 6 | string
MANDATE_CONTRACT_DESCR | In Out |
Description of the underlying contract between the debtor
and the creditor.
| | |
| 6 | string
MANDATE_UNIQUE_REFERENCE | In Out |
A unique reference number for the mandate.
| | |
| 6 | timestamp
MANDATE_SIGNED_T | In Out |
Date when the mandate is signed. This cannot be before the account creation date or a future date.
| | |
| 6 | string
MANDATE_SIGNED_PLACE | In Out |
Place where the mandate is signed.
Array to store SEPA compliant customer's bank account details.
Street address of the contact.
City portion of the address.
Country portion of the address.
Name of the contact.
Zipcode.
| | |
| 7 | string
IDENTIFICATION_CODE | In Out |
Debtor identification code.
Name of the Debtor Reference Party.
| | |
| 7 | string
REF_PARTY_ID_CODE | In Out |
Identification code of the Debtor Reference Party.
| | |
| 6 | string
CREDITOR_ID | In Out |
Identification code of the Creditor.
| | |
| 6 | string
CREDITOR_NAME | In Out |
Name of the Creditor.
The balance group info array. The element-id is significant, but not
the contents. The element-id will be used to identify which balance
group array to use from the input. If it is not present then a
default balance group will be created for the billinfo.
| |
| 10001 | Indicates invoice type(PIN_PAY_TYPE_INVOICE). |
| |
| 10003 | Indicates credit card type(PIN_PAY_TYPE_CC). |
| |
| 10005 | Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD). |
| |
| 10007 | Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD). |
| |
| 10018 | |
| |
| 10101 | . |
This represents the type of billing for user.
This flag indicates if this billinfo has subordinates or not. A value
of 0 indicates no subordinates and a value of 1 indicates that it has
subordinates.
Anniversary billing slot.
| | |
| 3 | int
ACTG_FUTURE_DOM | In Out |
New Accounting Close day-of-month (1-31).
| |
| 1 | This represents "open items" type of accounting. With open item
accounting customer's bill does not include amounts from previous
bill, if not paid(PIN_ACTG_TYPE_OPEN_ITEMS). |
| |
| 2 | This represents "balance forward" type of accounting. With balance
forward accounting customer's bill will include amounts from
previous bill, if not paid(PIN_ACTG_TYPE_BALANCE_FORWARD). |
Accounting type of the billinfo. Possible values are
PIN_ACTG_TYPE_OPEN_ITEMS(1) and PIN_ACTG_TYPE_BALANCE_FORWARD(2).This
field is used to allocate items for payment. If not specified, the
configuration entry actg_type is read from pin.conf of CM. If CM's
pin.conf does not have actg_type entry active, then default
accounting type will be balance forward type.
| | |
| 3 | enum
BILLING_STATUS | In Out |
| |
| 0 | Indicates billing status is active(PIN_BILL_ACTIVE). |
| |
| 1 | Indicates billing status is inactive(PIN_BILL_INACTIVE). |
Indicates whether the billinfo should be billed or it should be
suspended for billing.
| | |
| 3 | int
BILLING_STATUS_FLAGS | In Out |
Indicates a reason for setting of the given billing status.
| |
| 10100 | Indicates an active billinfo(PIN_STATUS_ACTIVE). |
| |
| 10102 | Indicates an inactive billinfo(PIN_STATUS_INACTIVE). |
| |
| 10103 | Indicates a closed billinfo(PIN_STATUS_CLOSED). |
Status of the billinfo: active, inactive, or closed.
Indicates a reason for setting of the given status.
It indicates whether this billinfo has a sponsoree.
| 3 | int
SPONSOREE_FLAGS | In Out |
It indicates whether this billinfo has a sponsor.
| | |
| 3 | poid
AR_BILLINFO_OBJ | In Out |
It indicates the AR billinfo for the given billinfo. It can be
present only for a subodinate billinfo.
| | |
| 3 | poid
PARENT_BILLINFO_OBJ | In Out |
It indicates the immediate (one level up) parent. Note that the given
billinfo is not necessarily a subordinate. The parent field may
reflect just child-parent relation. It should be mandatory if moving
to the new parent.
During account creation these values will be derived from the
account. In future when an account can have multiple currencies, the
value specified here will be used.
| | |
| 3 | int
CURRENCY_SECONDARY | In Out |
During account creation these values will be derived from the
account. In future when an account can have multiple currencies, the
value specified here will be used.
| | |
| 3 | enum
BILLING_SEGMENT | In Out |
It indicates the Billing Segment. A billing segment is a user defined
category such as wholesale or retail, that controls the accounting
DOMs to which a bill unit can be assigned.
The POID of Billinfo that this balance group will be associated with.
The fields PIN_FLD_BILLINFO and PIN_FLD_BILLINFO_OBJ are mutually
exclusive. If PIN_FLD_BILLINFO is available then PIN_FLD_BILLINFO_OBJ
will be ignored.
This an optional array to set the credit limit parameters. The
element id is significant and indicates the resource id for which the
limit is being set.
| | |
| 3 | decimal
CREDIT_LIMIT | In Out |
Limit for this resource. Current balance cannot exceed this limit
unless affected by a limit override rate or manually adjusted by a
CSR.
| | |
| 3 | decimal
CREDIT_FLOOR | In Out |
Baseline for calculating percentage for threshold triggers. Credit
limit minus credit floor is 100% of measured range. Credit floor
does NOT enforce any limit on current balance.
| | |
| 3 | decimal
CREDIT_THRESHOLDS_FIXED | In Out |
Limit for this resource. Current balance cannot exceed this limit
unless affected by a limit override rate or manually adjusted by a
CSR.
| | |
| 3 | int
CREDIT_THRESHOLDS | In Out |
Bit flags for triggering when resource balance crosses a boundary
when increasing in value.
| | | |
| Use | | optional |
| | | |
| Parent | | in.SERVICES.BAL_INFO.LIMIT |
| | | |
| ElemID mode | | ignored |
| | | |
| Iteration | | undefined |
| | | |
|
Allow ELEMID_ASSIGN
| | true |
| | | |
| Allow ELEMID_ANY | | true |
| | | |
| Recursive | | false |
Array of fixed threshold values.
Fixed threshold value.
Fixed threshold value in Decimal data type
This is an optional array to set the consumption rules for a
resource. The element id is significant and indicates a resource id
for which the limit as well as consumption rules are set.
| | |
| 3 | enum
CONSUMPTION_RULE | In Out |
| |
| 0 | The consumption rule is not defined
(PIN_CONSUMPTION_RULE_UNDEFINED). |
| |
| 1 | Earliest start time. Consume the sub-balance with the earliest
validity start time (earliest valid_from) first
(PIN_CONSUMPTION_RULE_EST). |
| |
| 2 | Latest start time. Consume the sub-balance with the latest
validity start time (latest valid_from) first
(PIN_CONSUMPTION_RULE_LST). |
| |
| 3 | Earliest expiration time. Consume the sub-balance that expires
first (earliest valid_to.)(PIN_CONSUMPTION_RULE_EET) |
| |
| 4 | Latest expiration time. Consume the sub-balance that expires last
(latest valid_to.)(PIN_CONSUMPTION_RULE_LET) |
| |
| 5 | Earliest start time and latest expiration time. Consume the
sub-balance with the earliest valid_from first. If more than one
sub-balances has the same valid_from, consume the one with the
latest valid_to first(PIN_CONSUMPTION_RULE_ESTLET). |
| |
| 6 | Earliest start time and earliest expiration time. Consume the
sub-balance with the earliest valid_from first. If more than one
sub-balances has the same valid_from, consume the one with the
earliest valid_to first(PIN_CONSUMPTION_RULE_ESTEET). |
| |
| 7 | Latest start time and earliest expiration time. Consume the
sub-balance with the latest sub-balance first. If more than one
sub-balances has the same valid_from, consume the one with the
earliest expired sub-balance first(PIN_CONSUMPTION_RULE_LSTEET).
|
| |
| 8 | Latest start time and latest expiration time. Consume the
sub-balance with the latest valid_from first. If more than one
sub-balances has the same valid_from, consume the one with the
latest valid_to first(PIN_CONSUMPTION_RULE_LSTLET). |
| |
| 9 | Earliest expiration time and earliest start time. Consume the
sub-balance with the earliest valid_to first. If more than one
sub-balances has the same valid_to, consume the one with the
earliest valid_from first(PIN_CONSUMPTION_RULE_EETEST). |
| |
| 10 | Earliest expiration time and latest start time. Consume the
sub-balance with the earliest valid_to first. If more than one
sub-balances has the same valid_to, consume the one with the
latest valid_from first(PIN_CONSUMPTION_RULE_EETLST). |
| |
| 11 | Latest expiration time and earliest start time. Consume the
sub-balance with the latest valid_to first. If more than one
sub-balances has the same valid_to, use the one with the earliest
valid_from first(PIN_CONSUMPTION_RULE_LETEST). |
| |
| 12 | Latest expiration time and latest start time. Consume the
sub-balance with the latest valid_to first. If more than one
sub-balances has the same valid_to, use the one with the latest
valid_from first(PIN_CONSUMPTION_RULE_LETLST). |
Consumption rule to be applied on the resource.
The balance group object for the service. Either PIN_FLD_BAL_INFO or
PIN_FLD_BAL_GRP_OBJ must be specified. If PIN_FLD_BAL_INFO is passed
in, this field will be ignored.
Login for service object. It is optional for telco and GSM services,
mandatory for email and ip services.
| | | |
| Use | | optional |
| | | |
| Parent | | in.SERVICES |
| | | |
| ElemID mode | | index |
| | | |
| Min number of Elements | | 0 |
The array of new aliases. The element-id is significant.
The alias.
| | |
| 1 | string
PASSWD_CLEAR | In Out |
Password for service object.
| | |
| 1 | enum
PASSWD_STATUS | In Out |
| |
| 0 | The password status is valid and normal
(PIN_SERV_PASSWDSTATUS_NORMAL). |
| |
| 1 | The password status is valid and is temporary
(PIN_SERV_PASSWDSTATUS_TEMPORARY). |
| |
| 2 | The password status is "expires" (PIN_SERV_PASSWDSTATUS_EXPIRES). |
| |
| 3 | The password status is invalid(PIN_SERV_PASSWDSTATUS_INVALID). |
Desired password status. The possible values are NORMAL(0), TEMP(1),
EXPIRES(2) and INVALID(3).
Deal that service object purchased (if any). This is for backward
compatibility for the Plan not having PIN_FLD_DEALS array.
| | |
| 1 | substruct
DEAL_INFO | In Out |
Deal to be purchased at service level. The DEAL_INFO and
PIN_FLD_DEAL_OBJ are mutually exclusive. Sometimes we may purchase
the deal customized. So, the DEAL_INFO has the entire deal object
(the products and discounts in the deal should be passed) in the
PIN_FLD_DEAL_INFO sub-structure.
Name of the deal object. Present only if a customized deal is to be
purchased.
Deal description. This is a free text to describe product. Present
only if a customized deal is to be purchased.
Valid start time. Defines valid period for the deal object
(inclusive). Stored as desired time in server timezone. Present
only if a customized deal is to be purchased.
Valid end time. Defines valid period for the deal object
(non-inclusive). Stored as desired time in server timezone. If end
time is zero, valid period does not expire. Present only if a
customized deal is to be purchased.
Flag to indicate on demand bill at the deal level and has value
PIN_DEAL_FLG_BILL_ON_DEMAND for on demand billing. Present only if
a customized deal is to be purchased.
Products Array. Array of products to purchase for the deal. Present
only if a customized deal is to be purchased.
Poid of the product to purchase.
Poid of plan through which product is being purchased.
Quantity to purchase.
| |
| 0 | NOT_SET |
| |
| 1 | ACTIVE |
| |
| 2 | INACTIVE |
| |
| 3 | CANCELLED |
Status of this subscription product. Possible values are
NOT_SET(0)
ACTIVE(1)
INACTIVE(2)
CANCELLED(3)
| | |
| 3 | timestamp
PURCHASE_START_T | In Out |
Purchase start time. Number of seconds into the future relative
to purchase time that product activates (0 means immediately).
| | |
| 3 | int
PURCHASE_START_UNIT | In Out |
For first usage start, the start_unit will be -1. The start date can
be specified in relative units, if it is not set for first usage. The
values can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 3 | int
PURCHASE_START_OFFSET | In Out |
For first usage start, the start_offset will be 0 and relative
offset can be specified for purchase if first usage option is not
marked. To be used in conjunction with unit to calculate
purchase_start_t with reference to the event time.
| | |
| 3 | timestamp
PURCHASE_END_T | In Out |
Purchase end time. Number of seconds into the future relative to
purchase time that product expires (0 means that product does not
expire).
| | |
| 3 | int
PURCHASE_END_UNIT | In Out |
Relative Unit for Purchase can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 3 | int
PURCHASE_END_OFFSET | In Out |
Relative offset for Purchase to be used in conjunction with unit
to calculate purchase end_t.
| | |
| 3 | decimal
PURCHASE_DISCOUNT | In Out |
Purchase discount. The percentage discount applied to
purchase/cancel rates of product.
| | |
| 3 | decimal
PURCHASE_DISC_AMT | In Out |
Fixed amount discount for purchase fees amount of discount
applied to purchase/cancel rates of product.
| | |
| 3 | decimal
PURCHASE_FEE_AMT | In Out |
Purchase fee to be applied for this product. Amount specified
here will override the price specified in the /rate object.
The value of
STATUS_FLAGS should also be set to
PIN_PROD_STATUS_FLAGS_OVERRIDE_PURCHASE_FEE.
| | |
| 3 | timestamp
CYCLE_START_T | In Out |
Cycle fee start time. Number of seconds into the future relative
to purchase time that cycle fees begin for this product (0 means
immediately).
| | |
| 3 | int
CYCLE_START_UNIT | In Out |
For first usage start, the start_unit will be -1. The start date can
be specified in relative units if it is not set for first usage. The
values can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 3 | int
CYCLE_START_OFFSET | In Out |
For first usage start, the start_offset will be 0 and relative
offset can be specified for cycle if first usage option is not
marked. To be used in conjunction with unit to calculate
cycle_start_t with reference to the event time.
| | |
| 3 | timestamp
CYCLE_END_T | In Out |
Cycle fee end time. Number of seconds into the future relative to
purchase time that cycle fees are no longer applied for this
product (0 means always applied).
| | |
| 3 | int
CYCLE_END_UNIT | In Out |
Relative Unit for Cycle can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 3 | int
CYCLE_END_OFFSET | In Out |
Relative offset for Cycle to be used in conjunction with unit to
calculate cycle end_t.
| | |
| 3 | decimal
CYCLE_DISCOUNT | In Out |
Cycle fee discount. The percent discount applied to cycle rates
of product.
| | |
| 3 | decimal
CYCLE_DISC_AMT | In Out |
Fixed amount discount applied to cycle rates of product.
| | |
| 3 | decimal
CYCLE_FEE_AMT | In Out |
Cycle fee (both forward and arrears) to be applied for this
product. Amount specified here will override the price specified
in the /rate object.The value of
STATUS_FLAGS should also be set to PIN_PROD_STATUS_FLAGS_OVERRIDE_CYCLE_FEE.
Status flags used in conjunction with the override prices
specified in
PURCHASE_FEE_AMT and
CYCLE_FEE_AMT. The possible values are: -
PIN_PROD_STATUS_FLAGS_OVERRIDE_PURCHASE_FEE(0x01000000)
PIN_PROD_STATUS_FLAGS_OVERRIDE_CYCLE_FEE(0x02000000)
| | |
| 3 | timestamp
USAGE_START_T | In Out |
Usage fee start time. Number of seconds into the future relative
to purchase time that usage fees begin for this product (0 means
immediately).
| | |
| 3 | int
USAGE_START_UNIT | In Out |
For first usage start, this field is -1. Otherwise the start date is
a relative offset, with the unit specified in this field as:
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 3 | int
USAGE_START_OFFSET | In Out |
For first usage, this field is 0. Otherwise, the start date is a
relative offset, which is specified by a combination of this
field and the start unit field.
| | |
| 3 | timestamp
USAGE_END_T | In Out |
Usage fee end time. Number ofseconds into the future relative to
purchase time that usage fees are no longer applied for this
product (0 means always applied).
| | |
| 3 | int
USAGE_END_UNIT | In Out |
Relative unit for Usage can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 3 | int
USAGE_END_OFFSET | In Out |
Relative offset for usage to be used in conjunction with unit to
calculate usage end_t.
| | |
| 3 | decimal
USAGE_DISCOUNT | In Out |
Usage fee discount. The percent discount applied to usage rates
of product.
Description on a per product basis for CSR to add comments.
| | |
| 3 | string
PRICE_LIST_NAME | In Out |
Price list name associated with this offering.
Discounts Array. Array of discounts to purchase for the deal.
Element-id is not significant. Present only if a customized deal is
to be purchased.
Poid of discount to purchase.
Poid of plan through which discount is being purchased.
Quantity to purchase.
| |
| 0 | NOT_SET |
| |
| 1 | ACTIVE |
| |
| 2 | INACTIVE |
| |
| 3 | CANCELLED |
Status of this subscription discount. Possible values are
NOT_SET(0)
ACTIVE(1)
INACTIVE(2)
CANCELLED(3)
For later use.
| | |
| 3 | timestamp
PURCHASE_START_T | In Out |
Purchase start time. Number of seconds into the future relative
to purchase time that discount activates.
| | |
| 3 | int
PURCHASE_START_UNIT | In Out |
For first usage start, the start_unit will be -1. The start date can
be specified in relative units if it is not set for first usage. The
values can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 3 | int
PURCHASE_START_OFFSET | In Out |
For first usage start, the start_offset will be 0 and relative
offset can be specified for purchase, if first usage option is
not marked. To be used in conjunction with unit to calculate
purchase_start_t with reference to the event time.
| | |
| 3 | timestamp
PURCHASE_END_T | In Out |
Purchase end time. Number of seconds into the future relative to
purchase time that discount expires (0 means that discount does
not expire).
| | |
| 3 | int
PURCHASE_END_UNIT | In Out |
Relative Unit for Purchase can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 3 | int
PURCHASE_END_OFFSET | In Out |
Relative offset for Purchase to be used in conjunction with unit
to calculate purchase end_t.
| | |
| 3 | timestamp
CYCLE_START_T | In Out |
Cycle fee start time. Number of seconds into the future relative
to purchase time that cycle fees begin for this discount (0 means
immediately).
| | |
| 3 | int
CYCLE_START_UNIT | In Out |
For first usage start, the start_unit will be -1. The start date can
be specified in relative units if it is not set for first usage. The
values can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 3 | int
CYCLE_START_OFFSET | In Out |
For first usage start, the start_offset will be 0 and relative
offset can be specified for purchase, if first usage option is
not marked. To be used in conjunction with unit to calculate
cycle_start_t with reference to the event time.
| | |
| 3 | timestamp
CYCLE_END_T | In Out |
Cycle fee end time. Number of seconds into the future relative to
purchase time that cycle fees are no longer applied for this
discount (0 means always applied).
| | |
| 3 | int
CYCLE_END_UNIT | In Out |
Relative unit for Cycle can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 3 | int
CYCLE_END_OFFSET | In Out |
Relative offset for Cycle to be used in conjunction with unit to
calculate Cycle end_t.
| | |
| 3 | timestamp
USAGE_START_T | In Out |
Usage fee start time. Number of seconds into the future relative
to purchase time that usage fees begin for this discount (0 means
immediately).
| | |
| 3 | int
USAGE_START_UNIT | In Out |
For first usage start, this field is -1. Otherwise the start date is
a relative offset, with the unit specified in this field as:
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 3 | int
USAGE_START_OFFSET | In Out |
For first usage, this field is 0. Otherwise, the start date is a
relative offset, which is specified by a combination of this
field and the start unit field.
| | |
| 3 | timestamp
USAGE_END_T | In Out |
Usage fee end time. Number of seconds into the future relative to
purchase time that usage fees are no longer applied for this
discount (0 means always applied).
| | |
| 3 | int
USAGE_END_UNIT | In Out |
Relative unit for Usage can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 3 | int
USAGE_END_OFFSET | In Out |
Relative offset for Usage to be used in conjunction with unit to
calculate Usage end_t on First Usage.
Description on a per discount basis for CSR to add comments.
Permitted array. Contains type strings for account and service
object types that are permitted to purchase this deal. Each entry
is implicitly appended with a wildcard for checking, so account and
service types that were inherited from a permitted type are also
permitted themselves. No entries implies any account or service
type is permitted to purchase the deal. Element-id is not
significant.
Object type - identifies an allowed account or service object
type.
| | | |
| Use | | optional |
| | | |
| Parent | | in.SERVICES |
| | | |
| ElemID mode | | ignored |
| | | |
| Iteration | | undefined |
| | | |
| Min number of Elements | | 0 |
This is the array of deals that this service purchases.
This indicates the deal poid that will be purchased without
customization.
| |
| 0 | PIN_PRICE_DEAL_OPTIONAL |
| |
| 1 | PIN_PRICE_DEAL_REQUIRED |
Deal option type. Required only if a valid service id is provided.
| | |
| 2 | substruct
DEAL_INFO | In Out |
Deal to be purchased at service level. The DEAL_INFO and
PIN_FLD_DEAL_OBJ are mutually exclusive. Sometimes we may purchase
the deal customized. So, the DEAL_INFO has the entire deal object
(the products and discounts in the deal should be passed) in the
PIN_FLD_DEAL_INFO sub-structure.
Name of the deal object. Present only if a customized deal is to
be purchased.
Deal description. This is a free text to describe product.
Present only if a customized deal is to be purchased.
Valid start time. Defines valid period for the deal object
(inclusive). Stored as desired time in server timezone. Present
only if a customized deal is to be purchased.
Valid end time. Defines valid period for the deal object
(non-inclusive). Stored as desired time in server timezone. If
end time is zero, valid period does not expire. Present only if a
customized deal is to be purchased.
Flag to indicate on demand bill at the deal level and has value
PIN_DEAL_FLG_BILL_ON_DEMAND for on demand billing. Present only
if a customized deal is to be purchased.
Products Array. Array of products to purchase for the deal.
Present only if a customized deal is to be purchased.
Poid of the product to purchase.
Poid of plan through which product is being purchased.
Quantity to purchase.
| |
| 0 | NOT_SET |
| |
| 1 | ACTIVE |
| |
| 2 | INACTIVE |
| |
| 3 | CANCELLED |
Status of this subscription product. Possible values are
NOT_SET(0)
ACTIVE(1)
INACTIVE(2)
CANCELLED(3)
| | |
| 4 | timestamp
PURCHASE_START_T | In Out |
Purchase start time. Number of seconds into the future relative
to purchase time that product activates (0 means immediately).
| | |
| 4 | int
PURCHASE_START_UNIT | In Out |
For first usage start, the start_unit will be -1. The start date
can be specified in relative units, if it is not set for first
usage. The values can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 4 | int
PURCHASE_START_OFFSET | In Out |
For first usage start, the start_offset will be 0 and relative
offset can be specified for purchase if first usage option is
not marked. To be used in conjunction with unit to calculate
purchase_start_t with reference to the event time.
| | |
| 4 | timestamp
PURCHASE_END_T | In Out |
Purchase end time. Number of seconds into the future relative
to purchase time that product expires (0 means that product
does not expire).
| | |
| 4 | int
PURCHASE_END_UNIT | In Out |
Relative Unit for Purchase can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 4 | int
PURCHASE_END_OFFSET | In Out |
Relative offset for Purchase to be used in conjunction with
unit to calculate purchase end_t.
| | |
| 4 | decimal
PURCHASE_DISCOUNT | In Out |
Purchase discount. The percentage discount applied to
purchase/cancel rates of product.
| | |
| 4 | decimal
PURCHASE_DISC_AMT | In Out |
Fixed amount discount for purchase fees amount of discount
applied to purchase/cancel rates of product.
| | |
| 4 | decimal
PURCHASE_FEE_AMT | In Out |
Purchase fee to be applied for this product. Amount specified
here will override the price specified in the /rate object.
The value of
STATUS_FLAGS should also be set to
PIN_PROD_STATUS_FLAGS_OVERRIDE_PURCHASE_FEE.
| | |
| 4 | timestamp
CYCLE_START_T | In Out |
Cycle fee start time. Number of seconds into the future
relative to purchase time that cycle fees begin for this
product (0 means immediately).
| | |
| 4 | int
CYCLE_START_UNIT | In Out |
For first usage start, the start_unit will be -1. The start date
can be specified in relative units if it is not set for first
usage. The values can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 4 | int
CYCLE_START_OFFSET | In Out |
For first usage start, the start_offset will be 0 and relative
offset can be specified for cycle if first usage option is not
marked. To be used in conjunction with unit to calculate
cycle_start_t with reference to the event time.
| | |
| 4 | timestamp
CYCLE_END_T | In Out |
Cycle fee end time. Number of seconds into the future relative
to purchase time that cycle fees are no longer applied for this
product (0 means always applied).
| | |
| 4 | int
CYCLE_END_UNIT | In Out |
Relative Unit for Cycle can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 4 | int
CYCLE_END_OFFSET | In Out |
Relative offset for Cycle to be used in conjunction with unit
to calculate cycle end_t.
| | |
| 4 | decimal
CYCLE_DISCOUNT | In Out |
Cycle fee discount. The percent discount applied to cycle rates
of product.
| | |
| 4 | decimal
CYCLE_DISC_AMT | In Out |
Fixed amount discount applied to cycle rates of product.
| | |
| 4 | decimal
CYCLE_FEE_AMT | In Out |
Cycle fee (both forward and arrears) to be applied for this
product. Amount specified here will override the price specified
in the /rate object.The value of
STATUS_FLAGS should also be set to PIN_PROD_STATUS_FLAGS_OVERRIDE_CYCLE_FEE.
Status flags used in conjunction with the override prices
specified in
PURCHASE_FEE_AMT and
CYCLE_FEE_AMT. The possible values are: -
PIN_PROD_STATUS_FLAGS_OVERRIDE_PURCHASE_FEE(0x01000000)
PIN_PROD_STATUS_FLAGS_OVERRIDE_CYCLE_FEE(0x02000000)
| | |
| 4 | timestamp
USAGE_START_T | In Out |
Usage fee start time. Number of seconds into the future
relative to purchase time that usage fees begin for this
product (0 means immediately).
| | |
| 4 | int
USAGE_START_UNIT | In Out |
For first usage start, this field is -1. Otherwise the start date
is a relative offset, with the unit specified in this field as:
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 4 | int
USAGE_START_OFFSET | In Out |
For first usage, this field is 0. Otherwise, the start date is
a relative offset, which is specified by a combination of this
field and the start unit field.
| | |
| 4 | timestamp
USAGE_END_T | In Out |
Usage fee end time. Number ofseconds into the future relative
to purchase time that usage fees are no longer applied for this
product (0 means always applied).
| | |
| 4 | int
USAGE_END_UNIT | In Out |
Relative unit for Usage can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 4 | int
USAGE_END_OFFSET | In Out |
Relative offset for usage to be used in conjunction with unit
to calculate usage end_t.
| | |
| 4 | decimal
USAGE_DISCOUNT | In Out |
Usage fee discount. The percent discount applied to usage rates
of product.
Description on a per product basis for CSR to add comments.
Discounts Array. Array of discounts to purchase for the deal.
Element-id is not significant. Present only if a customized deal
is to be purchased.
Poid of discount to purchase.
Poid of plan through which discount is being purchased.
Quantity to purchase.
| |
| 0 | NOT_SET |
| |
| 1 | ACTIVE |
| |
| 2 | INACTIVE |
| |
| 3 | CANCELLED |
Status of this subscription discount. Possible values are
NOT_SET(0)
ACTIVE(1)
INACTIVE(2)
CANCELLED(3)
For later use.
| | |
| 4 | timestamp
PURCHASE_START_T | In Out |
Purchase start time. Number of seconds into the future relative
to purchase time that discount activates.
| | |
| 4 | int
PURCHASE_START_UNIT | In Out |
For first usage start, the start_unit will be -1. The start date
can be specified in relative units if it is not set for first
usage. The values can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 4 | int
PURCHASE_START_OFFSET | In Out |
For first usage start, the start_offset will be 0 and relative
offset can be specified for purchase, if first usage option is
not marked. To be used in conjunction with unit to calculate
purchase_start_t with reference to the event time.
| | |
| 4 | timestamp
PURCHASE_END_T | In Out |
Purchase end time. Number of seconds into the future relative
to purchase time that discount expires (0 means that discount
does not expire).
| | |
| 4 | int
PURCHASE_END_UNIT | In Out |
Relative Unit for Purchase can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 4 | int
PURCHASE_END_OFFSET | In Out |
Relative offset for Purchase to be used in conjunction with
unit to calculate purchase end_t.
| | |
| 4 | timestamp
CYCLE_START_T | In Out |
Cycle fee start time. Number of seconds into the future
relative to purchase time that cycle fees begin for this
discount (0 means immediately).
| | |
| 4 | int
CYCLE_START_UNIT | In Out |
For first usage start, the start_unit will be -1. The start date
can be specified in relative units if it is not set for first
usage. The values can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 4 | int
CYCLE_START_OFFSET | In Out |
For first usage start, the start_offset will be 0 and relative
offset can be specified for purchase, if first usage option is
not marked. To be used in conjunction with unit to calculate
cycle_start_t with reference to the event time.
| | |
| 4 | timestamp
CYCLE_END_T | In Out |
Cycle fee end time. Number of seconds into the future relative
to purchase time that cycle fees are no longer applied for this
discount (0 means always applied).
| | |
| 4 | int
CYCLE_END_UNIT | In Out |
Relative unit for Cycle can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 4 | int
CYCLE_END_OFFSET | In Out |
Relative offset for Cycle to be used in conjunction with unit
to calculate Cycle end_t.
| | |
| 4 | timestamp
USAGE_START_T | In Out |
Usage fee start time. Number of seconds into the future
relative to purchase time that usage fees begin for this
discount (0 means immediately).
| | |
| 4 | int
USAGE_START_UNIT | In Out |
For first usage start, this field is -1. Otherwise the start date
is a relative offset, with the unit specified in this field as:
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 4 | int
USAGE_START_OFFSET | In Out |
For first usage, this field is 0. Otherwise, the start date is
a relative offset, which is specified by a combination of this
field and the start unit field.
| | |
| 4 | timestamp
USAGE_END_T | In Out |
Usage fee end time. Number of seconds into the future relative
to purchase time that usage fees are no longer applied for this
discount (0 means always applied).
| | |
| 4 | int
USAGE_END_UNIT | In Out |
Relative unit for Usage can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 4 | int
USAGE_END_OFFSET | In Out |
Relative offset for Usage to be used in conjunction with unit
to calculate Usage end_t on First Usage.
Description on a per discount basis for CSR to add comments.
Permitted array. Contains type strings for account and service
object types that are permitted to purchase this deal. Each entry
is implicitly appended with a wildcard for checking, so account
and service types that were inherited from a permitted type are
also permitted themselves. No entries implies any account or
service type is permitted to purchase the deal. Element-id is not
significant.
Object type - identifies an allowed account or service object
type.
| | | |
| Use | | optional |
| | | |
| Parent | | in.SERVICES |
| | | |
| Min number of Elements | | 0 |
| | | |
| Max number of Elements | | 1 |
Desired Status Info - if not specified, an active service is created.
The element-id is not significant.
| |
| 10100 | Indicates an active service(PIN_STATUS_ACTIVE). |
| |
| 10102 | Indicates an inactive service(PIN_STATUS_INACTIVE). |
| |
| 10103 | Indicates a closed service(PIN_STATUS_CLOSED). |
Desired status of the service. The possible values of this field
would be PIN_STATUS_ACTIVE(10100) or PIN_STATUS_INACTIVE(10102).
Desired status flags. This indicates a reason for this service to
become inactive or closed.
| | |
| 2 | timestamp
CLOSE_WHEN_T | In Out |
Desired service close time
| | | |
| Use | | optional |
| | | |
| Parent | | in.SERVICES |
| | | |
| ElemID mode | | ignored |
| | | |
| Iteration | | undefined |
| | | |
| Min number of Elements | | 0 |
Profiles associate with this service
Partial poid of profile object to create. The 'type' and 'database'
sub-fields are used in the creation. The other sub-fields are
ignored. To modify a profile, specify the complete poid of the
profile object.
| | |
| 2 | substruct
INHERITED_INFO | In Out |
Inherited info for profile object.
| | |
| 1 | substruct
INHERITED_INFO | In Out |
Inherited info for service object.
This is a devices array. This contains an array of device poids to be
associated with the service being created.
Poid of the device that is to be associated.
| | | |
| Use | | optional |
| | | |
| ElemID mode | | index |
| | | |
| Iteration | | undefined |
| | | |
| Min number of Elements | | 0 |
This represents the array of Billing info's. The element id is
significant as it behaves as a key, in other objects like balance
groups (bal_info array) to be created during this operation, to
identify which billinfo element to associate with.
The type only billinfo poid to create the billinfo. To update the
existing billinfo, specify the complete billinfo poid. If poid
is not passed all billinfo's for the account will be
picked up for modification.
| | |
| 1 | poid
BUSINESS_PROFILE_OBJ | In Out |
| | | |
| Use | | optional |
| | | |
| Parent | | in.BILLINFO |
| | | |
| Class | | /config/business_profile |
Business profile poid. Pointer to the Business profile poid to which
this billinfo belongs.
| | |
| 1 | string
BILLINFO_ID | In Out |
This field identifies the billinfo by name.
| | |
| 1 | int
ACTG_CYCLE_DOM | In Out |
Billing date
| | | |
| Use | | optional |
| | | |
| Parent | | in.BILLINFO |
| | | |
| ElemID mode | | key |
| | | |
| Iteration | | undefined |
The Payinfo array. The element-id is significant, but not the
contents. The element-id will be used to identify which payinfo array
to use from the input. If it is not present then the payment method
is considered either as transient or voucher.
The partial poid of payinfo.
| |
| 10001 | Indicates invoice type(PIN_PAY_TYPE_INVOICE). |
| |
| 10003 | Indicates credit card type(PIN_PAY_TYPE_CC). |
| |
| 10005 | Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD). |
| |
| 10007 | Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD). |
| |
| 10018 | Indicates SEPA payment type(PIN_PAY_TYPE_SEPA). |
This represents the type of billing for user.
Payment term ID defines which payment term will be used in the
payment due date calculation.
| | |
| 2 | int
PAYMENT_OFFSET | In Out |
Payment offset value.
| |
| 0x01 | Indicates detail invoice(PIN_INV_TYPE_DETAIL). |
| |
| 0x02 | Indicates summary invoice(PIN_INV_TYPE_SUMMARY). |
| |
| 0x04 | Indicates regular invoice(PIN_INV_TYPE_REGULAR). |
| |
| 0x08 | Indicates subordinate invoice(PIN_INV_TYPE_SUBORDINATE). |
| |
| 0x10 | Indicates parent invoice(PIN_INV_TYPE_PARENT). |
| |
| 0x18 | Indicates parent with subordinates invoice
(PIN_INV_TYPE_PARENT_WITH_SUBORDS). |
| |
| 0x20 | Indicates hierarchy invoice(PIN_INV_TYPE_HIERARCHY). |
| |
| 0x40 | Indicates trial invoice(PIN_INV_TYPE_TRIAL_INVOICE). |
Indicates the type of invoice to be generated.
Partial Flag. This enables the operation to treat some fields
from the request as optional. Values are (0) mandatory,
or (1) optional. The fields affected are:
PIN_FLD_DEBIT_NUM, PIN_FLD_DEBIT_EXP, PIN_FLD_BANK_NO,
PIN_FLD_CITY, PIN_FLD_STATE, PIN_FLD_ZIP and PIN_FLD_COUNTRY.
| | |
| 2 | substruct
INHERITED_INFO | In Out |
All subclass fields for the payinfo object are included in this
substruct. The subclass depends on the pay_type. If pay_type is
invoice then this array element will have PIN_FLD_INV_INFO, etc.
This array element has fields related to invoice type of payment
menthod. There will be only one element and element id is not
significant.
Street address.
City.
Country.
| | |
| 4 | string
DELIVERY_DESCR | In Out |
Delivery mechanism.
| | |
| 4 | enum
DELIVERY_PREFER | In Out |
| |
| 0 | Indicates email delivery(PIN_INV_EMAIL_DELIVERY). |
| |
| 1 | Indicates mail delivery(PIN_INV_USP_DELIVERY). |
| |
| 3 | Indicates fax delivery(PIN_INV_FAX_DELIVERY). |
Prefered delivery method email(0), postal(1) and fax(3).
Comments to appear on each invoice.
Used for invoice terms to be printed on the invoice.
Email address to which invoice be delivered.
Name of party responsible for payment.
State or province.
Zip/Postal code.
This array element has fields related to credit card type of
payment menthod. There will be only one element and element id is
not significant.
Street Address
City.
Country.
Credit card expiration date (mmyy).
Credit card number.
Name as it appears on the credit card.
| | |
| 4 | string
SECURITY_ID | In Out |
Security ID. Used for credit card fraud prevention. This field
stores the 3 digit CVV2 for Visa and 4 digit CID for amex.
State or province.
Zip/Postal code.
This array element has fields related to direct debit type of
payment menthod. There will be only one element and element id is
not significant.
Street Address.
RDFI/Bank ID used for routing transactions.
City.
Country.
Customer's bank account number.
Name as it appears on the card.
State or province.
| |
| 1 | Checking Account type(PIN_ACCOUNT_TYPE_CHECKING). |
| |
| 2 | Savings Account type(PIN_ACCOUNT_TYPE_SAVINGS). |
| |
| 3 | Corporate Account type(PIN_ACCOUNT_TYPE_CORPORATE). |
Bank account type. Checking(1), savings(2) or corporate(3).
Zip/Postal code.
This array element has fields related to SEPA type of
payment method. There will be only one element and element id is
not significant.
| |
| 0 | One-off mandate. |
| |
| 1 | Recurring mandate. |
Mandate type whether it is one-off or recurring.
International Bank Account Number which
is a unique identifier for the bank account.
Bank Identifier Code which is a unique
identifier for the bank related to the account.
| | |
| 4 | string
MANDATE_CONTRACT_ID | In Out |
ID of the underlying contract between the debtor
and the creditor.
| | |
| 4 | string
MANDATE_CONTRACT_DESCR | In Out |
Description of the underlying contract between the debtor
and the creditor.
| | |
| 4 | string
MANDATE_UNIQUE_REFERENCE | In Out |
A unique reference number for the mandate.
| | |
| 4 | timestamp
MANDATE_SIGNED_T | In Out |
Date when the mandate is signed. This cannot be before the account creation date or a future date.
| | |
| 4 | string
MANDATE_SIGNED_PLACE | In Out |
Place where the mandate is signed.
| | | |
| Use | | required |
| | | |
| Parent | | in.BILLINFO.PAYINFO.INHERITED_INFO.SEPA_INFO |
| | | |
| ElemID mode | | ignored |
| | | |
| Iteration | | undefined |
| | | |
| Min number of Elements | | 0 |
| | | |
| Max number of Elements | | 1 |
| | | |
| Max ID | | 0 |
| | | |
| Allowed Elem ID List | | 0 |
| | | |
|
Allow ELEMID_ASSIGN
| | false |
| | | |
| Allow ELEMID_ANY | | false |
| | | |
| Recursive | | false |
Array to store SEPA compliant customer's bank account details.
Street address of the contact.
City portion of the address.
Country portion of the address.
Name of the contact.
Zipcode.
| | |
| 5 | string
IDENTIFICATION_CODE | In Out |
Debtor identification code.
Name of the Debtor Reference Party.
| | |
| 5 | string
REF_PARTY_ID_CODE | In Out |
Identification code of the Debtor Reference Party.
| | |
| 4 | string
CREDITOR_ID | In Out |
Identification code of the Creditor.
| | |
| 4 | string
CREDITOR_NAME | In Out |
Name of the Creditor.
| | | |
| Use | | optional |
| | | |
| Parent | | in.BILLINFO |
| | | |
| ElemID mode | | key |
| | | |
| Iteration | | undefined |
| | | |
| Min number of Elements | | 0 |
| | | |
| Max number of Elements | | 1 |
The balance group info array. The element-id is significant, but not
the contents. The element-id will be used to identify which balance
group array to use from the input. If it is not present then a
default balance group will be created for the billinfo.
The partial poid of the balance group to be created. During monitor
creation/update, Poid type of /balance_group/monitor is used.
Balance Group name.
The billinfo array element. Here the contents are not significant.
The element id will determine the billinfo that will be associated
with this balance group. if not specified then the first billinfo
that the system finds will be associated with this balance group.
The POID of Billinfo that this balance group will be associated with.
The fields PIN_FLD_BILLINFO and PIN_FLD_BILLINFO_OBJ are mutually
exclusive. If PIN_FLD_BILLINFO is available then PIN_FLD_BILLINFO_OBJ
will be ignored.
This an optional array to set the credit limit parameters. The
element id is significant and indicates the resource id for which the
limit is being set.
| | |
| 3 | decimal
CREDIT_LIMIT | In Out |
Limit for this resource. Current balance cannot exceed this limit
unless affected by a limit override rate or manually adjusted by a
CSR.
| | |
| 3 | decimal
CREDIT_FLOOR | In Out |
Baseline for calculating percentage for threshold triggers. Credit
limit minus credit floor is 100% of measured range. Credit floor
does NOT enforce any limit on current balance.
| | |
| 3 | decimal
CREDIT_THRESHOLDS_FIXED | In Out |
Limit for this resource. Current balance cannot exceed this limit
unless affected by a limit override rate or manually adjusted by a
CSR.
| | |
| 3 | int
CREDIT_THRESHOLDS | In Out |
Bit flags for triggering when resource balance crosses a boundary
when increasing in value.
| | | |
| Use | | optional |
| | | |
| Parent | | in.BILLINFO.BAL_INFO.LIMIT |
| | | |
| ElemID mode | | ignored |
| | | |
| Iteration | | undefined |
| | | |
|
Allow ELEMID_ASSIGN
| | true |
| | | |
| Allow ELEMID_ANY | | true |
| | | |
| Recursive | | false |
Array of fixed threshold values.
Fixed threshold value.
Fixed threshold value in Decimal data type
This is an optional array to set the consumption rules for a
resource. The element id is significant and indicates a resource id
for which the limit as well as consumption rules are set.
| | |
| 3 | enum
CONSUMPTION_RULE | In Out |
| |
| 0 | The consumption rule is not defined
(PIN_CONSUMPTION_RULE_UNDEFINED). |
| |
| 1 | Earliest start time. Consume the sub-balance with the earliest
validity start time (earliest valid_from) first
(PIN_CONSUMPTION_RULE_EST). |
| |
| 2 | Latest start time. Consume the sub-balance with the latest
validity start time (latest valid_from) first
(PIN_CONSUMPTION_RULE_LST). |
| |
| 3 | Earliest expiration time. Consume the sub-balance that expires
first (earliest valid_to.)(PIN_CONSUMPTION_RULE_EET) |
| |
| 4 | Latest expiration time. Consume the sub-balance that expires last
(latest valid_to.)(PIN_CONSUMPTION_RULE_LET) |
| |
| 5 | Earliest start time and latest expiration time. Consume the
sub-balance with the earliest valid_from first. If more than one
sub-balances has the same valid_from, consume the one with the
latest valid_to first(PIN_CONSUMPTION_RULE_ESTLET). |
| |
| 6 | Earliest start time and earliest expiration time. Consume the
sub-balance with the earliest valid_from first. If more than one
sub-balances has the same valid_from, consume the one with the
earliest valid_to first(PIN_CONSUMPTION_RULE_ESTEET). |
| |
| 7 | Latest start time and earliest expiration time. Consume the
sub-balance with the latest sub-balance first. If more than one
sub-balances has the same valid_from, consume the one with the
earliest expired sub-balance first(PIN_CONSUMPTION_RULE_LSTEET).
|
| |
| 8 | Latest start time and latest expiration time. Consume the
sub-balance with the latest valid_from first. If more than one
sub-balances has the same valid_from, consume the one with the
latest valid_to first(PIN_CONSUMPTION_RULE_LSTLET). |
| |
| 9 | Earliest expiration time and earliest start time. Consume the
sub-balance with the earliest valid_to first. If more than one
sub-balances has the same valid_to, consume the one with the
earliest valid_from first(PIN_CONSUMPTION_RULE_EETEST). |
| |
| 10 | Earliest expiration time and latest start time. Consume the
sub-balance with the earliest valid_to first. If more than one
sub-balances has the same valid_to, consume the one with the
latest valid_from first(PIN_CONSUMPTION_RULE_EETLST). |
| |
| 11 | Latest expiration time and earliest start time. Consume the
sub-balance with the latest valid_to first. If more than one
sub-balances has the same valid_to, use the one with the earliest
valid_from first(PIN_CONSUMPTION_RULE_LETEST). |
| |
| 12 | Latest expiration time and latest start time. Consume the
sub-balance with the latest valid_to first. If more than one
sub-balances has the same valid_to, use the one with the latest
valid_from first(PIN_CONSUMPTION_RULE_LETLST). |
Consumption rule to be applied on the resource.
The payinfo poid that this billinfo is associated with. If
PIN_FLD_PAYINFO is specified, this field will be ignored.
The balance group that this billinfo is associated with. If
PIN_FLD_BAL_INFO is specified, this field will be ignored.
| |
| 0 | Undefined pay type(PIN_PAY_TYPE_UNDEFINED). |
| |
| 10001 | Indicates invoice type(PIN_PAY_TYPE_INVOICE). |
| |
| 10003 | Indicates credit card type(PIN_PAY_TYPE_CC). |
| |
| 10005 | Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD). |
| |
| 10007 | Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD). |
This represents the type of billing for user.
Indicates if this billinfo has subordinates or not. A value of 0
indicates no subordinates and a value of 1 indicates that it has
subordinates.
Anniversary billing slot.
| | |
| 1 | int
ACTG_FUTURE_DOM | In Out |
New Accounting Close day-of-month (1-31).
| |
| 1 | This represents "open items" type of accounting. With open item
accounting customer's bill does not include amounts from previous
bill, if not paid(PIN_ACTG_TYPE_OPEN_ITEMS). |
| |
| 2 | This represents "balance forward" type of accounting. With balance
forward accounting customer's bill will include amounts from
previous bill, if not paid(PIN_ACTG_TYPE_BALANCE_FORWARD). |
Accounting type of the billinfo. Possible values are
PIN_ACTG_TYPE_OPEN_ITEMS(1) and PIN_ACTG_TYPE_BALANCE_FORWARD(2).This
field is used to allocate items for payment. If not specified, the
configuration entry actg_type is read from pin.conf of CM. If CM's
pin.conf does not have actg_type entry active, then default
accounting type will be balance forward type.
| | |
| 1 | enum
BILLING_STATUS | In Out |
| |
| 0 | Indicates billing status is active(PIN_BILL_ACTIVE). |
| |
| 1 | Indicates billing status is inactive(PIN_BILL_INACTIVE). |
Indicates whether the billinfo should be billed or it should be
suspended for billing.
| | |
| 1 | int
BILLING_STATUS_FLAGS | In Out |
Indicates a reason for setting of the given billing status.
| |
| 10100 | Indicates an active billinfo(PIN_STATUS_ACTIVE). |
| |
| 10102 | Indicates an inactive billinfo(PIN_STATUS_INACTIVE). |
| |
| 10103 | Indicates a closed billinfo(PIN_STATUS_CLOSED). |
Status of the billinfo: active, inactive, or closed.
Indicates a reason for setting of the given status.
It indicates whether this billinfo has a sponsoree.
| 1 | int
SPONSOREE_FLAGS | In Out |
It indicates whether this billinfo has a sponsor.
| | |
| 1 | poid
AR_BILLINFO_OBJ | In Out |
It indicates the AR billinfo for the given billinfo. It can be
present only for a subodinate billinfo.
| | |
| 1 | poid
PARENT_BILLINFO_OBJ | In Out |
It indicates the immediate (one level up) parent. Note that the given
billinfo is not necessarily a subordinate. The parent field may
reflect just child-parent relation. It should be mandatory if moving
to the new parent.
During account creation these values will be derived from the
account. In future when an account can have multiple currencies, the
value specified here will be used.
| | |
| 1 | int
CURRENCY_SECONDARY | In Out |
During account creation these values will be derived from the
account. In future when an account can have multiple currencies, the
value specified here will be used.
| | |
| 1 | enum
BILLING_SEGMENT | In Out |
It indicates the Billing Segment. A billing segment is a user defined
category such as wholesale or retail, that controls the accounting
DOMs to which a bill unit can be assigned.
| | | |
| Use | | optional |
| | | |
| ElemID mode | | index |
| | | |
| Iteration | | undefined |
| | | |
| Min number of Elements | | 0 |
The Balance Group array. List of balance groups that need to be created
or updated.
| | | |
| Use | | required |
| | | |
| Parent | | in.BAL_INFO |
| | | |
| Mode | | typeonly |
| | | |
| Class | | /balance_group |
The partial poid of the balance group to be created. During monitor
creation/update, Poid type of /balance_group/monitor is used. To
modify an existing balance group, specify the full POID.
Balance Group name
| | | |
| Use | | optional |
| | | |
| Parent | | in.BAL_INFO |
| | | |
| ElemID mode | | key |
| | | |
| Iteration | | undefined |
| | | |
| Min number of Elements | | 0 |
The billinfo array element. Here the contents are not significant.
The element id will determine the billinfo that will be associated
with this balance group. if not specified then the first billinfo
that the system finds will be associated with this balance group.
The type only billinfo poid.
| | |
| 2 | poid
BUSINESS_PROFILE_OBJ | In Out |
Business profile poid. Pointer to the Business profile poid to which
this billinfo belongs.
| | |
| 2 | string
BILLINFO_ID | In Out |
This field identifies the billinfo by name.
The Payinfo array. The element-id is significant, but not the
contents. The element-id will be used to identify which payinfo array
to use from the input. If it is not present then the payment method
is considered either as transient or voucher.
The partial poid of payinfo.
| |
| 10001 | Indicates invoice type(PIN_PAY_TYPE_INVOICE). |
| |
| 10003 | Indicates credit card type(PIN_PAY_TYPE_CC). |
| |
| 10005 | Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD). |
| |
| 10007 | Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD). |
| |
| 10018 | Indicates SEPA payment type(PIN_PAY_TYPE_SEPA). |
This represents the type of billing for user.
Payment term ID defines which payment term will be used in the
payment due date calculation.
| | |
| 3 | int
PAYMENT_OFFSET | In Out |
Payment offset value.
| |
| 0x01 | Indicates detail invoice(PIN_INV_TYPE_DETAIL). |
| |
| 0x02 | Indicates summary invoice(PIN_INV_TYPE_SUMMARY). |
| |
| 0x04 | Indicates regular invoice(PIN_INV_TYPE_REGULAR). |
| |
| 0x08 | Indicates subordinate invoice(PIN_INV_TYPE_SUBORDINATE). |
| |
| 0x10 | Indicates parent invoice(PIN_INV_TYPE_PARENT). |
| |
| 0x18 | Indicates parent with subordinates invoice
(PIN_INV_TYPE_PARENT_WITH_SUBORDS). |
| |
| 0x20 | Indicates hierarchy invoice(PIN_INV_TYPE_HIERARCHY). |
| |
| 0x40 | Indicates trial invoice(PIN_INV_TYPE_TRIAL_INVOICE). |
Indicates the type of invoice to be generated.
Partial Flag. This enables the operation to treat some fields
from the request as optional. Values are (0) mandatory,
or (1) optional. The fields affected are:
PIN_FLD_DEBIT_NUM, PIN_FLD_DEBIT_EXP, PIN_FLD_BANK_NO,
PIN_FLD_CITY, PIN_FLD_STATE, PIN_FLD_ZIP and PIN_FLD_COUNTRY.
| | |
| 3 | substruct
INHERITED_INFO | In Out |
All subclass fields for the payinfo object are included in this
substruct. The subclass depends on the pay_type. If pay_type is
invoice then this array element will have PIN_FLD_INV_INFO, etc.
This array element has fields related to invoice type of payment
menthod. There will be only one element and element id is not
significant.
Street address.
City.
Country.
| | |
| 5 | string
DELIVERY_DESCR | In Out |
Delivery mechanism.
| | |
| 5 | enum
DELIVERY_PREFER | In Out |
| |
| 0 | Indicates email delivery(PIN_INV_EMAIL_DELIVERY). |
| |
| 1 | Indicates mail delivery(PIN_INV_USP_DELIVERY). |
| |
| 3 | Indicates fax delivery(PIN_INV_FAX_DELIVERY). |
Prefered delivery method email(0), postal(1) and fax(3).
Comments to appear on each invoice.
Used for invoice terms to be printed on the invoice.
Email address to which invoice be delivered.
Name of party responsible for payment.
State or province.
Zip/Postal code.
This array element has fields related to credit card type of
payment menthod. There will be only one element and element id is
not significant.
Street Address
City.
Country.
Credit card expiration date (mmyy).
Credit card number.
Name as it appears on the credit card.
| | |
| 5 | string
SECURITY_ID | In Out |
Security ID. Used for credit card fraud prevention. This field
stores the 3 digit CVV2 for Visa and 4 digit CID for amex.
State or province.
Zip/Postal code.
This array element has fields related to direct debit type of
payment menthod. There will be only one element and element id is
not significant.
Street Address.
RDFI/Bank ID used for routing transactions.
City.
Country.
Customer's bank account number.
Name as it appears on the card.
State or province.
| |
| 1 | Checking Account type(PIN_ACCOUNT_TYPE_CHECKING). |
| |
| 2 | Savings Account type(PIN_ACCOUNT_TYPE_SAVINGS). |
| |
| 3 | Corporate Account type(PIN_ACCOUNT_TYPE_CORPORATE). |
Bank account type. Checking(1), savings(2) or corporate(3).
Zip/Postal code.
This array element has fields related to SEPA type of
payment method. There will be only one element and element id is
not significant.
| |
| 0 | One-off mandate. |
| |
| 1 | Recurring mandate. |
Mandate type whether it is one-off or recurring.
International Bank Account Number which
is a unique identifier for the bank account.
Bank Identifier Code which is a unique
identifier for the bank related to the account.
| | |
| 5 | string
MANDATE_CONTRACT_ID | In Out |
ID of the underlying contract between the debtor
and the creditor.
| | |
| 5 | string
MANDATE_CONTRACT_DESCR | In Out |
Description of the underlying contract between the debtor
and the creditor.
| | |
| 5 | string
MANDATE_UNIQUE_REFERENCE | In Out |
A unique reference number for the mandate.
| | |
| 5 | timestamp
MANDATE_SIGNED_T | In Out |
Date when the mandate is signed. This cannot be before the account creation date or a future date.
| | |
| 5 | string
MANDATE_SIGNED_PLACE | In Out |
Place where the mandate is signed.
Array to store SEPA compliant customer's bank account details.
Street address of the contact.
City portion of the address.
Country portion of the address.
Name of the contact.
Zipcode.
| | |
| 6 | string
IDENTIFICATION_CODE | In Out |
Debtor identification code.
Name of the Debtor Reference Party.
| | |
| 6 | string
REF_PARTY_ID_CODE | In Out |
Identification code of the Debtor Reference Party.
| | |
| 5 | string
CREDITOR_ID | In Out |
Identification code of the Creditor.
| | |
| 5 | string
CREDITOR_NAME | In Out |
Name of the Creditor.
| | | |
| Use | | optional |
| | | |
| Parent | | in.BAL_INFO.BILLINFO |
| | | |
| ElemID mode | | key |
| | | |
| Iteration | | undefined |
| | | |
| Min number of Elements | | 0 |
| | | |
| Max number of Elements | | 1 |
The balance group info array. The element-id is significant, but not
the contents. The element-id will be used to identify which balance
group array to use from the input. If it is not present then a
default balance group will be created for the billinfo.
| |
| 10001 | Indicates invoice type(PIN_PAY_TYPE_INVOICE). |
| |
| 10003 | Indicates credit card type(PIN_PAY_TYPE_CC). |
| |
| 10005 | Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD). |
| |
| 10007 | Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD). |
| |
| 10018 | |
| |
| 10101 | . |
This represents the type of billing for user.
This flag indicates if this billinfo has subordinates or not. A value
of 0 indicates no subordinates and a value of 1 indicates that it has
subordinates.
Anniversary billing slot.
| | |
| 2 | int
ACTG_FUTURE_DOM | In Out |
New Accounting Close day-of-month (1-31).
| |
| 1 | This represents "open items" type of accounting. With open item
accounting customer's bill does not include amounts from previous
bill, if not paid(PIN_ACTG_TYPE_OPEN_ITEMS). |
| |
| 2 | This represents "balance forward" type of accounting. With balance
forward accounting customer's bill will include amounts from
previous bill, if not paid(PIN_ACTG_TYPE_BALANCE_FORWARD). |
Accounting type of the billinfo. Possible values are
PIN_ACTG_TYPE_OPEN_ITEMS(1) and PIN_ACTG_TYPE_BALANCE_FORWARD(2).This
field is used to allocate items for payment. If not specified, the
configuration entry actg_type is read from pin.conf of CM. If CM's
pin.conf does not have actg_type entry active, then default
accounting type will be balance forward type.
| | |
| 2 | enum
BILLING_STATUS | In Out |
| |
| 0 | Indicates billing status is active(PIN_BILL_ACTIVE). |
| |
| 1 | Indicates billing status is inactive(PIN_BILL_INACTIVE). |
Indicates whether the billinfo should be billed or it should be
suspended for billing.
| | |
| 2 | int
BILLING_STATUS_FLAGS | In Out |
Indicates a reason for setting of the given billing status.
| |
| 10100 | Indicates an active billinfo(PIN_STATUS_ACTIVE). |
| |
| 10102 | Indicates an inactive billinfo(PIN_STATUS_INACTIVE). |
| |
| 10103 | Indicates a closed billinfo(PIN_STATUS_CLOSED). |
Status of the billinfo: active, inactive, or closed.
Indicates a reason for setting of the given status.
It indicates whether this billinfo has a sponsoree.
| 2 | int
SPONSOREE_FLAGS | In Out |
It indicates whether this billinfo has a sponsor.
| | |
| 2 | poid
AR_BILLINFO_OBJ | In Out |
It indicates the AR billinfo for the given billinfo. It can be
present only for a subodinate billinfo.
| | |
| 2 | poid
PARENT_BILLINFO_OBJ | In Out |
It indicates the immediate (one level up) parent. Note that the given
billinfo is not necessarily a subordinate. The parent field may
reflect just child-parent relation. It should be mandatory if moving
to the new parent.
During account creation these values will be derived from the
account. In future when an account can have multiple currencies, the
value specified here will be used.
| | |
| 2 | int
CURRENCY_SECONDARY | In Out |
During account creation these values will be derived from the
account. In future when an account can have multiple currencies, the
value specified here will be used.
| | |
| 2 | enum
BILLING_SEGMENT | In Out |
It indicates the Billing Segment. A billing segment is a user defined
category such as wholesale or retail, that controls the accounting
DOMs to which a bill unit can be assigned.
The POID of Billinfo that this balance group will be associated with.
The fields PIN_FLD_BILLINFO and PIN_FLD_BILLINFO_OBJ are mutually
exclusive. If PIN_FLD_BILLINFO is available then PIN_FLD_BILLINFO_OBJ
will be ignored.
| | | |
| Use | | optional |
| | | |
| Parent | | in.BAL_INFO |
| | | |
| ElemID mode | | index |
| | | |
| Iteration | | undefined |
| | | |
| Min number of Elements | | 0 |
This an optional array to set the credit limit parameters. The
element id is significant and indicates the resource id for which the
limit is being set.
| | |
| 2 | decimal
CREDIT_LIMIT | In Out |
Limit for this resource. Current balance cannot exceed this limit
unless affected by a limit override rate or manually adjusted by a
CSR.
| | |
| 2 | decimal
CREDIT_FLOOR | In Out |
Baseline for calculating percentage for threshold triggers. Credit
limit minus credit floor is 100% of measured range. Credit floor
does NOT enforce any limit on current balance.
| | |
| 2 | int
CREDIT_THRESHOLDS | In Out |
Bit flags for triggering when resource balance crosses a boundary
when increasing in value.
| | | |
| Use | | optional |
| | | |
| Parent | | in.BAL_INFO.LIMIT |
| | | |
| ElemID mode | | ignored |
| | | |
| Iteration | | undefined |
| | | |
|
Allow ELEMID_ASSIGN
| | true |
| | | |
| Allow ELEMID_ANY | | true |
| | | |
| Recursive | | false |
Array of fixed threshold values.
Fixed threshold value.
Fixed threshold value in Decimal data type
| | | |
| Use | | optional |
| | | |
| Parent | | in.BAL_INFO |
| | | |
| ElemID mode | | index |
| | | |
| Iteration | | undefined |
| | | |
| Min number of Elements | | 0 |
This is an optional array to set the consumption rules for a
resource. The element id is significant and indicates a resource id
for which the limit as well as consumption rules are set.
| | |
| 2 | enum
CONSUMPTION_RULE | In Out |
| |
| 0 | The consumption rule is not defined
(PIN_CONSUMPTION_RULE_UNDEFINED). |
| |
| 1 | Earliest start time. Consume the sub-balance with the earliest
validity start time (earliest valid_from) first
(PIN_CONSUMPTION_RULE_EST). |
| |
| 2 | Latest start time. Consume the sub-balance with the latest
validity start time (latest valid_from) first
(PIN_CONSUMPTION_RULE_LST). |
| |
| 3 | Earliest expiration time. Consume the sub-balance that expires
first (earliest valid_to.)(PIN_CONSUMPTION_RULE_EET) |
| |
| 4 | Latest expiration time. Consume the sub-balance that expires last
(latest valid_to.)(PIN_CONSUMPTION_RULE_LET) |
| |
| 5 | Earliest start time and latest expiration time. Consume the
sub-balance with the earliest valid_from first. If more than one
sub-balances has the same valid_from, consume the one with the
latest valid_to first(PIN_CONSUMPTION_RULE_ESTLET). |
| |
| 6 | Earliest start time and earliest expiration time. Consume the
sub-balance with the earliest valid_from first. If more than one
sub-balances has the same valid_from, consume the one with the
earliest valid_to first(PIN_CONSUMPTION_RULE_ESTEET). |
| |
| 7 | Latest start time and earliest expiration time. Consume the
sub-balance with the latest sub-balance first. If more than one
sub-balances has the same valid_from, consume the one with the
earliest expired sub-balance first(PIN_CONSUMPTION_RULE_LSTEET). |
| |
| 8 | Latest start time and latest expiration time. Consume the
sub-balance with the latest valid_from first. If more than one
sub-balances has the same valid_from, consume the one with the
latest valid_to first(PIN_CONSUMPTION_RULE_LSTLET). |
| |
| 9 | Earliest expiration time and earliest start time. Consume the
sub-balance with the earliest valid_to first. If more than one
sub-balances has the same valid_to, consume the one with the
earliest valid_from first(PIN_CONSUMPTION_RULE_EETEST). |
| |
| 10 | Earliest expiration time and latest start time. Consume the
sub-balance with the earliest valid_to first. If more than one
sub-balances has the same valid_to, consume the one with the
latest valid_from first(PIN_CONSUMPTION_RULE_EETLST). |
| |
| 11 | Latest expiration time and earliest start time. Consume the
sub-balance with the latest valid_to first. If more than one
sub-balances has the same valid_to, use the one with the earliest
valid_from first(PIN_CONSUMPTION_RULE_LETEST). |
| |
| 12 | Latest expiration time and latest start time. Consume the
sub-balance with the latest valid_to first. If more than one
sub-balances has the same valid_to, use the one with the latest
valid_from first(PIN_CONSUMPTION_RULE_LETLST). |
Consumption rule to be applied on the resource.
| | | |
| Use | | optional |
| | | |
| ElemID mode | | index |
| | | |
| Iteration | | undefined |
| | | |
| Min number of Elements | | 1 |
This is an array of payment methods to be associated with this account.
| | | |
| Use | | required |
| | | |
| Parent | | in.PAYINFO |
| | | |
| Mode | | typeonly |
| | | |
| Class | | /payinfo |
The partial poid of payinfo to be created. In case of an update to an
existing payinfo, specifiy the actual payinfo poid.
| |
| 0 | Undefined pay type(PIN_PAY_TYPE_UNDEFINED). |
| |
| 10001 | Indicates invoice type(PIN_PAY_TYPE_INVOICE). |
| |
| 10003 | Indicates credit card type(PIN_PAY_TYPE_CC). |
| |
| 10005 | Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD). |
| |
| 10007 | Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD). |
This represents the type of billing for user.
Payment term ID defines which payment term will be used in the
payment due date calculation.
| | |
| 1 | int
PAYMENT_OFFSET | In Out |
Payment Offset.
| |
| 0x01 | Indicates detail invoice(PIN_INV_TYPE_DETAIL). |
| |
| 0x02 | Indicates summary invoice(PIN_INV_TYPE_SUMMARY). |
| |
| 0x04 | Indicates regular invoice(PIN_INV_TYPE_REGULAR). |
| |
| 0x08 | Indicates subordinate invoice(PIN_INV_TYPE_SUBORDINATE). |
| |
| 0x10 | Indicates parent invoice(PIN_INV_TYPE_PARENT) |
| |
| 0x18 | Indicates parent with subordinates invoice
(PIN_INV_TYPE_PARENT_WITH_SUBORDS). |
| |
| 0x20 | Indicates hierarchy invoice(PIN_INV_TYPE_HIERARCHY). |
| |
| 0x40 | Indicates trial invoice(PIN_INV_TYPE_TRIAL_INVOICE). |
Indicates the type of invoice to be generated.
Partial Flag. This enables the operation to treat some fields
from the request as optional. Values are (0) mandatory,
or (1) optional. The fields affected are:
PIN_FLD_DEBIT_NUM, PIN_FLD_DEBIT_EXP, PIN_FLD_BANK_NO,
PIN_FLD_CITY, PIN_FLD_STATE, PIN_FLD_ZIP and PIN_FLD_COUNTRY.
| | |
| 1 | substruct
INHERITED_INFO | In Out |
All subclass fields for the payinfo object are included in this
substruct. The subclass depends on the pay_type. If pay_type is
invoice then this array element will have PIN_FLD_INV_INFO, etc.
| | | |
| Use | | optional |
| | | |
| Parent | | in.PAYINFO.INHERITED_INFO |
| | | |
| ElemID mode | | ignored |
| | | |
| Iteration | | undefined |
| | | |
| Min number of Elements | | 0 |
| | | |
| Max number of Elements | | 1 |
This array element has fields related to invoice type of payment
menthod. There will be only one element and element id is not
significant.
Street address.
City.
Country.
| | |
| 3 | string
DELIVERY_DESCR | In Out |
Delivery mechanism.
| | |
| 3 | enum
DELIVERY_PREFER | In Out |
| |
| 0 | Indicates email delivery(PIN_INV_EMAIL_DELIVERY). |
| |
| 1 | Indicates mail delivery(PIN_INV_USP_DELIVERY). |
| |
| 3 | Indicates fax delivery(PIN_INV_FAX_DELIVERY). |
Prefered delivery method email(0), postal(1) and fax(3).
Comments to appear on each invoice.
Used for invoice terms to be printed on the invoice.
Email address to which invoice be delivered.
Name of party responsible for payment.
State or province.
Zip/Postal code.
| | | |
| Use | | optional |
| | | |
| Parent | | in.PAYINFO.INHERITED_INFO |
| | | |
| ElemID mode | | ignored |
| | | |
| Iteration | | undefined |
| | | |
| Min number of Elements | | 0 |
| | | |
| Max number of Elements | | 1 |
This array element has fields related to credit card type of
payment menthod. There will be only one element and element id is
not significant.
Street Address.
City.
Country.
Credit card expiration date (mmyy).
Credit card number.
Name as it appears on the credit card.
| | |
| 3 | string
SECURITY_ID | In Out |
Security ID. Used for credit card fraud prevention. This field
stores the 3 digit CVV2 for Visa and 4 digit CID for amex.
State or province.
Zip/Postal code.
| | | |
| Use | | optional |
| | | |
| Parent | | in.PAYINFO.INHERITED_INFO |
| | | |
| ElemID mode | | ignored |
| | | |
| Iteration | | undefined |
| | | |
| Min number of Elements | | 0 |
| | | |
| Max number of Elements | | 1 |
This array element has fields related to direct debit type of
payment menthod. There will be only one element and element id is
not significant.
Street Address.
RDFI/Bank ID used for routing transactions.
City.
Country.
Customer's bank account number.
Name as it appears on the card.
State or province.
| |
| 1 | Checking Account type(PIN_ACCOUNT_TYPE_CHECKING). |
| |
| 2 | Savings Account type(PIN_ACCOUNT_TYPE_SAVINGS). |
| |
| 3 | Corporate Account type(PIN_ACCOUNT_TYPE_CORPORATE). |
Bank account type- Checking(1), savings(2) or corporate(3).
Zip/Postal code.
| | | |
| Use | | optional |
| | | |
| Parent | | in.PAYINFO.INHERITED_INFO |
| | | |
| ElemID mode | | ignored |
| | | |
| Iteration | | undefined |
| | | |
| Min number of Elements | | 0 |
| | | |
| Max number of Elements | | 1 |
This array element has fields related to SEPA type of
payment menthod. There will be only one element and element id is
not significant.
| |
| 0 | One-off mandate. |
| |
| 1 | Recurring mandate. |
Mandate type whether it is one-off or recurring.
International Bank Account Number which
is a unique identifier for the bank account.
Bank Identifier Code which is a unique
identifier for the bank related to the account.
| | |
| 3 | string
MANDATE_CONTRACT_ID | In Out |
ID of the underlying contract between the debtor
and the creditor.
| | |
| 3 | string
MANDATE_CONTRACT_DESCR | In Out |
Description of the underlying contract between the debtor
and the creditor.
| | |
| 3 | string
MANDATE_UNIQUE_REFERENCE | In Out |
A unique reference number for the mandate.
| | | |
| Use | | optional |
| | | |
| Parent | | in.PAYINFO.INHERITED_INFO.SEPA_INFO |
| | | |
| ElemID mode | | ignored |
| | | |
| Iteration | | undefined |
| | | |
| Min number of Elements | | 0 |
| | | |
| Max number of Elements | | 1 |
| | | |
| Max ID | | 0 |
| | | |
| Allowed Elem ID List | | 0 |
| | | |
|
Allow ELEMID_ASSIGN
| | false |
| | | |
| Allow ELEMID_ANY | | false |
| | | |
| Recursive | | false |
Array to store SEPA compliant customer's bank account details.
Street address of the contact.
City portion of the address.
Country portion of the address.
Name of the contact.
Zipcode.
| | |
| 4 | string
IDENTIFICATION_CODE | In Out |
Debtor identification code.
Name of the Debtor Reference Party.
| | |
| 4 | string
REF_PARTY_ID_CODE | In Out |
Identification code of the Debtor Reference Party.
| | |
| 3 | string
CREDITOR_ID | In Out |
Identification code of the Creditor.
| | |
| 3 | string
CREDITOR_NAME | In Out |
Name of the Creditor.
| | | |
| Use | | optional |
| | | |
| ElemID mode | | ignored |
| | | |
| Iteration | | undefined |
| | | |
| Min number of Elements | | 0 |
This represnts Profile array to be associated with the account.
| | | |
| Use | | required |
| | | |
| Parent | | in.PROFILES |
| | | |
| Mode | | typeonly |
| | | |
| Class | | /profile |
Partial poid of profile object to create. The 'type' and 'database'
sub-fields are used in the creation. The other sub-fields are
ignored. In case of modification to an existing profile specify the
actual poid of the profile.
| | |
| 1 | substruct
INHERITED_INFO | In Out |
Inherited info for profile object.
| | | |
| Use | | optional |
| | | |
| ElemID mode | | ignored |
| | | |
| Iteration | | undefined |
| | | |
| Min number of Elements | | 0 |
Topup array
Topup poid - type only for creation.
Account poid.
| | | |
| Use | | required |
| | | |
| Parent | | in.TOPUP_INFO |
| | | |
| ElemID mode | | key |
| | | |
| Iteration | | undefined |
| | | |
| Min number of Elements | | 1 |
The element-id is significant. Contents are not significant. The
element id points to the payinfo array element in the request to
be used for top-up.
The partial poid of payinfo.
| |
| 10001 | Indicates invoice type(PIN_PAY_TYPE_INVOICE). |
| |
| 10003 | Indicates credit card type(PIN_PAY_TYPE_CC). |
| |
| 10005 | Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD). |
| |
| 10007 | Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD). |
| |
| 10018 | Indicates SEPA payment type(PIN_PAY_TYPE_SEPA). |
This represents the type of billing for user.
Payment term ID defines which payment term will be used in the
payment due date calculation.
| | |
| 2 | int
PAYMENT_OFFSET | In Out |
Payment offset value.
| |
| 0x01 | Indicates detail invoice(PIN_INV_TYPE_DETAIL). |
| |
| 0x02 | Indicates summary invoice(PIN_INV_TYPE_SUMMARY). |
| |
| 0x04 | Indicates regular invoice(PIN_INV_TYPE_REGULAR). |
| |
| 0x08 | Indicates subordinate invoice(PIN_INV_TYPE_SUBORDINATE). |
| |
| 0x10 | Indicates parent invoice(PIN_INV_TYPE_PARENT). |
| |
| 0x18 | Indicates parent with subordinates invoice
(PIN_INV_TYPE_PARENT_WITH_SUBORDS). |
| |
| 0x20 | Indicates hierarchy invoice(PIN_INV_TYPE_HIERARCHY). |
| |
| 0x40 | Indicates trial invoice(PIN_INV_TYPE_TRIAL_INVOICE). |
Indicates the type of invoice to be generated.
Partial Flag. This enables the operation to treat some fields
from the request as optional. Values are (0) mandatory,
or (1) optional. The fields affected are:
PIN_FLD_DEBIT_NUM, PIN_FLD_DEBIT_EXP, PIN_FLD_BANK_NO,
PIN_FLD_CITY, PIN_FLD_STATE, PIN_FLD_ZIP and PIN_FLD_COUNTRY.
| | |
| 2 | substruct
INHERITED_INFO | In Out |
All subclass fields for the payinfo object are included in this
substruct. The subclass depends on the pay_type. If pay_type is
invoice then this array element will have PIN_FLD_INV_INFO, etc.
This array element has fields related to invoice type of payment
menthod. There will be only one element and element id is not
significant.
Street address.
City.
Country.
| | |
| 4 | string
DELIVERY_DESCR | In Out |
Delivery mechanism.
| | |
| 4 | enum
DELIVERY_PREFER | In Out |
| |
| 0 | Indicates email delivery(PIN_INV_EMAIL_DELIVERY). |
| |
| 1 | Indicates mail delivery(PIN_INV_USP_DELIVERY). |
| |
| 3 | Indicates fax delivery(PIN_INV_FAX_DELIVERY). |
Prefered delivery method email(0), postal(1) and fax(3).
Comments to appear on each invoice.
Used for invoice terms to be printed on the invoice.
Email address to which invoice be delivered.
Name of party responsible for payment.
State or province.
Zip/Postal code.
This array element has fields related to credit card type of
payment menthod. There will be only one element and element id is
not significant.
Street Address
City.
Country.
Credit card expiration date (mmyy).
Credit card number.
Name as it appears on the credit card.
| | |
| 4 | string
SECURITY_ID | In Out |
Security ID. Used for credit card fraud prevention. This field
stores the 3 digit CVV2 for Visa and 4 digit CID for amex.
State or province.
Zip/Postal code.
This array element has fields related to direct debit type of
payment menthod. There will be only one element and element id is
not significant.
Street Address.
RDFI/Bank ID used for routing transactions.
City.
Country.
Customer's bank account number.
Name as it appears on the card.
State or province.
| |
| 1 | Checking Account type(PIN_ACCOUNT_TYPE_CHECKING). |
| |
| 2 | Savings Account type(PIN_ACCOUNT_TYPE_SAVINGS). |
| |
| 3 | Corporate Account type(PIN_ACCOUNT_TYPE_CORPORATE). |
Bank account type. Checking(1), savings(2) or corporate(3).
Zip/Postal code.
This array element has fields related to SEPA type of
payment method. There will be only one element and element id is
not significant.
| |
| 0 | One-off mandate. |
| |
| 1 | Recurring mandate. |
Mandate type whether it is one-off or recurring.
International Bank Account Number which
is a unique identifier for the bank account.
Bank Identifier Code which is a unique
identifier for the bank related to the account.
| | |
| 4 | string
MANDATE_CONTRACT_ID | In Out |
ID of the underlying contract between the debtor
and the creditor.
| | |
| 4 | string
MANDATE_CONTRACT_DESCR | In Out |
Description of the underlying contract between the debtor
and the creditor.
| | |
| 4 | string
MANDATE_UNIQUE_REFERENCE | In Out |
A unique reference number for the mandate.
| | |
| 4 | timestamp
MANDATE_SIGNED_T | In Out |
Date when the mandate is signed. This cannot be before the account creation date or a future date.
| | |
| 4 | string
MANDATE_SIGNED_PLACE | In Out |
Place where the mandate is signed.
| | | |
| Use | | required |
| | | |
| Parent | | in.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO |
| | | |
| ElemID mode | | ignored |
| | | |
| Iteration | | undefined |
| | | |
| Min number of Elements | | 0 |
| | | |
| Max number of Elements | | 1 |
| | | |
| Max ID | | 0 |
| | | |
| Allowed Elem ID List | | 0 |
| | | |
|
Allow ELEMID_ASSIGN
| | false |
| | | |
| Allow ELEMID_ANY | | false |
| | | |
| Recursive | | false |
Array to store SEPA compliant customer's bank account details.
Street address of the contact.
City portion of the address.
Country portion of the address.
Name of the contact.
Zipcode.
| | |
| 5 | string
IDENTIFICATION_CODE | In Out |
Debtor identification code.
Name of the Debtor Reference Party.
| | |
| 5 | string
REF_PARTY_ID_CODE | In Out |
Identification code of the Debtor Reference Party.
| | |
| 4 | string
CREDITOR_ID | In Out |
Identification code of the Creditor.
| | |
| 4 | string
CREDITOR_NAME | In Out |
Name of the Creditor.
The payinfo object that this topup is associated with. If
PIN_FLD_PAYINFO is passed in, this field will be ignored. If
PIN_FLD_PAYINFO is not passed in, this becomes a mandatory field.
| | | |
| Use | | required |
| | | |
| Parent | | in.TOPUP_INFO |
| | | |
| ElemID mode | | key |
| | | |
| Iteration | | undefined |
| | | |
| Min number of Elements | | 1 |
The element-id is significant. Contents are not significant. The
element id points to the billinfo array element in the request to
be used for top-up.
The type only billinfo poid.
| | |
| 2 | poid
BUSINESS_PROFILE_OBJ | In Out |
Business profile poid. Pointer to the Business profile poid to which
this billinfo belongs.
| | |
| 2 | string
BILLINFO_ID | In Out |
This field identifies the billinfo by name.
The Payinfo array. The element-id is significant, but not the
contents. The element-id will be used to identify which payinfo array
to use from the input. If it is not present then the payment method
is considered either as transient or voucher.
The partial poid of payinfo.
| |
| 10001 | Indicates invoice type(PIN_PAY_TYPE_INVOICE). |
| |
| 10003 | Indicates credit card type(PIN_PAY_TYPE_CC). |
| |
| 10005 | Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD). |
| |
| 10007 | Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD). |
| |
| 10018 | Indicates SEPA payment type(PIN_PAY_TYPE_SEPA). |
This represents the type of billing for user.
Payment term ID defines which payment term will be used in the
payment due date calculation.
| | |
| 3 | int
PAYMENT_OFFSET | In Out |
Payment offset value.
| |
| 0x01 | Indicates detail invoice(PIN_INV_TYPE_DETAIL). |
| |
| 0x02 | Indicates summary invoice(PIN_INV_TYPE_SUMMARY). |
| |
| 0x04 | Indicates regular invoice(PIN_INV_TYPE_REGULAR). |
| |
| 0x08 | Indicates subordinate invoice(PIN_INV_TYPE_SUBORDINATE). |
| |
| 0x10 | Indicates parent invoice(PIN_INV_TYPE_PARENT). |
| |
| 0x18 | Indicates parent with subordinates invoice
(PIN_INV_TYPE_PARENT_WITH_SUBORDS). |
| |
| 0x20 | Indicates hierarchy invoice(PIN_INV_TYPE_HIERARCHY). |
| |
| 0x40 | Indicates trial invoice(PIN_INV_TYPE_TRIAL_INVOICE). |
Indicates the type of invoice to be generated.
Partial Flag. This enables the operation to treat some fields
from the request as optional. Values are (0) mandatory,
or (1) optional. The fields affected are:
PIN_FLD_DEBIT_NUM, PIN_FLD_DEBIT_EXP, PIN_FLD_BANK_NO,
PIN_FLD_CITY, PIN_FLD_STATE, PIN_FLD_ZIP and PIN_FLD_COUNTRY.
| | |
| 3 | substruct
INHERITED_INFO | In Out |
All subclass fields for the payinfo object are included in this
substruct. The subclass depends on the pay_type. If pay_type is
invoice then this array element will have PIN_FLD_INV_INFO, etc.
This array element has fields related to invoice type of payment
menthod. There will be only one element and element id is not
significant.
Street address.
City.
Country.
| | |
| 5 | string
DELIVERY_DESCR | In Out |
Delivery mechanism.
| | |
| 5 | enum
DELIVERY_PREFER | In Out |
| |
| 0 | Indicates email delivery(PIN_INV_EMAIL_DELIVERY). |
| |
| 1 | Indicates mail delivery(PIN_INV_USP_DELIVERY). |
| |
| 3 | Indicates fax delivery(PIN_INV_FAX_DELIVERY). |
Prefered delivery method email(0), postal(1) and fax(3).
Comments to appear on each invoice.
Used for invoice terms to be printed on the invoice.
Email address to which invoice be delivered.
Name of party responsible for payment.
State or province.
Zip/Postal code.
This array element has fields related to credit card type of
payment menthod. There will be only one element and element id is
not significant.
Street Address
City.
Country.
Credit card expiration date (mmyy).
Credit card number.
Name as it appears on the credit card.
| | |
| 5 | string
SECURITY_ID | In Out |
Security ID. Used for credit card fraud prevention. This field
stores the 3 digit CVV2 for Visa and 4 digit CID for amex.
State or province.
Zip/Postal code.
This array element has fields related to direct debit type of
payment menthod. There will be only one element and element id is
not significant.
Street Address.
RDFI/Bank ID used for routing transactions.
City.
Country.
Customer's bank account number.
Name as it appears on the card.
State or province.
| |
| 1 | Checking Account type(PIN_ACCOUNT_TYPE_CHECKING). |
| |
| 2 | Savings Account type(PIN_ACCOUNT_TYPE_SAVINGS). |
| |
| 3 | Corporate Account type(PIN_ACCOUNT_TYPE_CORPORATE). |
Bank account type. Checking(1), savings(2) or corporate(3).
Zip/Postal code.
This array element has fields related to SEPA type of
payment method. There will be only one element and element id is
not significant.
| |
| 0 | One-off mandate. |
| |
| 1 | Recurring mandate. |
Mandate type whether it is one-off or recurring.
International Bank Account Number which
is a unique identifier for the bank account.
Bank Identifier Code which is a unique
identifier for the bank related to the account.
| | |
| 5 | string
MANDATE_CONTRACT_ID | In Out |
ID of the underlying contract between the debtor
and the creditor.
| | |
| 5 | string
MANDATE_CONTRACT_DESCR | In Out |
Description of the underlying contract between the debtor
and the creditor.
| | |
| 5 | string
MANDATE_UNIQUE_REFERENCE | In Out |
A unique reference number for the mandate.
| | |
| 5 | timestamp
MANDATE_SIGNED_T | In Out |
Date when the mandate is signed. This cannot be before the account creation date or a future date.
| | |
| 5 | string
MANDATE_SIGNED_PLACE | In Out |
Place where the mandate is signed.
Array to store SEPA compliant customer's bank account details.
Street address of the contact.
City portion of the address.
Country portion of the address.
Name of the contact.
Zipcode.
| | |
| 6 | string
IDENTIFICATION_CODE | In Out |
Debtor identification code.
Name of the Debtor Reference Party.
| | |
| 6 | string
REF_PARTY_ID_CODE | In Out |
Identification code of the Debtor Reference Party.
| | |
| 5 | string
CREDITOR_ID | In Out |
Identification code of the Creditor.
| | |
| 5 | string
CREDITOR_NAME | In Out |
Name of the Creditor.
| | | |
| Use | | optional |
| | | |
| Parent | | in.TOPUP_INFO.BILLINFO |
| | | |
| ElemID mode | | key |
| | | |
| Iteration | | undefined |
| | | |
| Min number of Elements | | 0 |
| | | |
| Max number of Elements | | 1 |
The balance group info array. The element-id is significant, but not
the contents. The element-id will be used to identify which balance
group array to use from the input. If it is not present then a
default balance group will be created for the billinfo.
The partial poid of the balance group to be created. During monitor
creation/update, Poid type of /balance_group/monitor is used.
Balance Group name.
The billinfo array element. Here the contents are not significant.
The element id will determine the billinfo that will be associated
with this balance group. if not specified then the first billinfo
that the system finds will be associated with this balance group.
The POID of Billinfo that this balance group will be associated with.
The fields PIN_FLD_BILLINFO and PIN_FLD_BILLINFO_OBJ are mutually
exclusive. If PIN_FLD_BILLINFO is available then PIN_FLD_BILLINFO_OBJ
will be ignored.
This an optional array to set the credit limit parameters. The
element id is significant and indicates the resource id for which the
limit is being set.
| | |
| 4 | decimal
CREDIT_LIMIT | In Out |
Limit for this resource. Current balance cannot exceed this limit
unless affected by a limit override rate or manually adjusted by a
CSR.
| | |
| 4 | decimal
CREDIT_FLOOR | In Out |
Baseline for calculating percentage for threshold triggers. Credit
limit minus credit floor is 100% of measured range. Credit floor
does NOT enforce any limit on current balance.
| | |
| 4 | decimal
CREDIT_THRESHOLDS_FIXED | In Out |
Limit for this resource. Current balance cannot exceed this limit
unless affected by a limit override rate or manually adjusted by a
CSR.
| | |
| 4 | int
CREDIT_THRESHOLDS | In Out |
Bit flags for triggering when resource balance crosses a boundary
when increasing in value.
Array of fixed threshold values.
Fixed threshold value.
Fixed threshold value in Decimal data type
This is an optional array to set the consumption rules for a
resource. The element id is significant and indicates a resource id
for which the limit as well as consumption rules are set.
| | |
| 4 | enum
CONSUMPTION_RULE | In Out |
| |
| 0 | The consumption rule is not defined
(PIN_CONSUMPTION_RULE_UNDEFINED). |
| |
| 1 | Earliest start time. Consume the sub-balance with the earliest
validity start time (earliest valid_from) first
(PIN_CONSUMPTION_RULE_EST). |
| |
| 2 | Latest start time. Consume the sub-balance with the latest
validity start time (latest valid_from) first
(PIN_CONSUMPTION_RULE_LST). |
| |
| 3 | Earliest expiration time. Consume the sub-balance that expires
first (earliest valid_to.)(PIN_CONSUMPTION_RULE_EET) |
| |
| 4 | Latest expiration time. Consume the sub-balance that expires last
(latest valid_to.)(PIN_CONSUMPTION_RULE_LET) |
| |
| 5 | Earliest start time and latest expiration time. Consume the
sub-balance with the earliest valid_from first. If more than one
sub-balances has the same valid_from, consume the one with the
latest valid_to first(PIN_CONSUMPTION_RULE_ESTLET). |
| |
| 6 | Earliest start time and earliest expiration time. Consume the
sub-balance with the earliest valid_from first. If more than one
sub-balances has the same valid_from, consume the one with the
earliest valid_to first(PIN_CONSUMPTION_RULE_ESTEET). |
| |
| 7 | Latest start time and earliest expiration time. Consume the
sub-balance with the latest sub-balance first. If more than one
sub-balances has the same valid_from, consume the one with the
earliest expired sub-balance first(PIN_CONSUMPTION_RULE_LSTEET).
|
| |
| 8 | Latest start time and latest expiration time. Consume the
sub-balance with the latest valid_from first. If more than one
sub-balances has the same valid_from, consume the one with the
latest valid_to first(PIN_CONSUMPTION_RULE_LSTLET). |
| |
| 9 | Earliest expiration time and earliest start time. Consume the
sub-balance with the earliest valid_to first. If more than one
sub-balances has the same valid_to, consume the one with the
earliest valid_from first(PIN_CONSUMPTION_RULE_EETEST). |
| |
| 10 | Earliest expiration time and latest start time. Consume the
sub-balance with the earliest valid_to first. If more than one
sub-balances has the same valid_to, consume the one with the
latest valid_from first(PIN_CONSUMPTION_RULE_EETLST). |
| |
| 11 | Latest expiration time and earliest start time. Consume the
sub-balance with the latest valid_to first. If more than one
sub-balances has the same valid_to, use the one with the earliest
valid_from first(PIN_CONSUMPTION_RULE_LETEST). |
| |
| 12 | Latest expiration time and latest start time. Consume the
sub-balance with the latest valid_to first. If more than one
sub-balances has the same valid_to, use the one with the latest
valid_from first(PIN_CONSUMPTION_RULE_LETLST). |
Consumption rule to be applied on the resource.
| |
| 10001 | Indicates invoice type(PIN_PAY_TYPE_INVOICE). |
| |
| 10003 | Indicates credit card type(PIN_PAY_TYPE_CC). |
| |
| 10005 | Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD). |
| |
| 10007 | Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD). |
| |
| 10018 | |
| |
| 10101 | . |
This represents the type of billing for user.
This flag indicates if this billinfo has subordinates or not. A value
of 0 indicates no subordinates and a value of 1 indicates that it has
subordinates.
Anniversary billing slot.
| | |
| 2 | int
ACTG_FUTURE_DOM | In Out |
New Accounting Close day-of-month (1-31).
| |
| 1 | This represents "open items" type of accounting. With open item
accounting customer's bill does not include amounts from previous
bill, if not paid(PIN_ACTG_TYPE_OPEN_ITEMS). |
| |
| 2 | This represents "balance forward" type of accounting. With balance
forward accounting customer's bill will include amounts from
previous bill, if not paid(PIN_ACTG_TYPE_BALANCE_FORWARD). |
Accounting type of the billinfo. Possible values are
PIN_ACTG_TYPE_OPEN_ITEMS(1) and PIN_ACTG_TYPE_BALANCE_FORWARD(2).This
field is used to allocate items for payment. If not specified, the
configuration entry actg_type is read from pin.conf of CM. If CM's
pin.conf does not have actg_type entry active, then default
accounting type will be balance forward type.
| | |
| 2 | enum
BILLING_STATUS | In Out |
| |
| 0 | Indicates billing status is active(PIN_BILL_ACTIVE). |
| |
| 1 | Indicates billing status is inactive(PIN_BILL_INACTIVE). |
Indicates whether the billinfo should be billed or it should be
suspended for billing.
| | |
| 2 | int
BILLING_STATUS_FLAGS | In Out |
Indicates a reason for setting of the given billing status.
| |
| 10100 | Indicates an active billinfo(PIN_STATUS_ACTIVE). |
| |
| 10102 | Indicates an inactive billinfo(PIN_STATUS_INACTIVE). |
| |
| 10103 | Indicates a closed billinfo(PIN_STATUS_CLOSED). |
Status of the billinfo: active, inactive, or closed.
Indicates a reason for setting of the given status.
It indicates whether this billinfo has a sponsoree.
| 2 | int
SPONSOREE_FLAGS | In Out |
It indicates whether this billinfo has a sponsor.
| | |
| 2 | poid
AR_BILLINFO_OBJ | In Out |
It indicates the AR billinfo for the given billinfo. It can be
present only for a subodinate billinfo.
| | |
| 2 | poid
PARENT_BILLINFO_OBJ | In Out |
It indicates the immediate (one level up) parent. Note that the given
billinfo is not necessarily a subordinate. The parent field may
reflect just child-parent relation. It should be mandatory if moving
to the new parent.
During account creation these values will be derived from the
account. In future when an account can have multiple currencies, the
value specified here will be used.
| | |
| 2 | int
CURRENCY_SECONDARY | In Out |
During account creation these values will be derived from the
account. In future when an account can have multiple currencies, the
value specified here will be used.
| | |
| 2 | enum
BILLING_SEGMENT | In Out |
It indicates the Billing Segment. A billing segment is a user defined
category such as wholesale or retail, that controls the accounting
DOMs to which a bill unit can be assigned.
The POID of Billinfo that this topup is associated with. If
PIN_FLD_BILLINFO is passed in, this field will be ignored. If
PIN_FLD_BILLINFO is not passed in, this becomes a mandatory field.
This represents Topup amount. In case of auto-topups this will
indicate the amount to topup with.
Topup cap indicates the max topup that can be done for a given cycle.
The cycle is driven by the cycle information set-up in the billinfo.
A values of 0 means no cap.
| | |
| 1 | decimal
CYCLE_TOPPED_AMT | In Out |
This indicates the total topped up amount during the given cycle.
This amount will be populated only if the cap is set.
| | |
| 1 | timestamp
LAST_TOPUP_T | In Out |
This indicates the when the last topup happened.
| | |
| 1 | array
GROUP_TOPUP_INFO | In Out |
| | | |
| Use | | optional |
| | | |
| Parent | | in.TOPUP_INFO |
| | | |
| ElemID mode | | ignored |
| | | |
| Iteration | | undefined |
| | | |
| Min number of Elements | | 0 |
The field represents sponsored topup. The array contains fields
related to Sponsored topup only.
The /group/topup poid. Poid of sponsored topup group involved in
the creation/modification of member account. If the object instance
exists, the poid is complete poid with valid poid number. If no
object instance exists, the poid is type only poid.
Parent's account poid.
The Name of the /group/topup. This helps to identify the group.
Balance Group of the parent/payer of the /group/topup.
| | |
| 2 | array
GROUP_TOPUP_LIMITS | In Out |
Represents /group/topup financial properties per resource id.
Resource id of topup operation
Topup amount is used in automatic sponsored topup.
Topup cap is used as a maximum limit of topup for particular
topup group during cycle.
| | |
| 2 | array
GROUP_TOPUP_MEMBERS | In Out |
Represents members' properties of the /group/topup.
Balance Group of a member of the /group/topup.
| | |
| 3 | int
TOPUP_INTERVAL | In Out |
This indicates the interval at which automatic sponsored topup
occur.
The PIN which will be used for authentication during Ad-Hoc topup.
| |
| 10100 | Indicates an active member(PIN_STATUS_ACTIVE). |
| |
| 10102 | Indicates an inactive member(PIN_STATUS_INACTIVE). |
| |
| 10103 | Indicates a closed member(PIN_STATUS_CLOSED). |
The status of the member (active/inactive/closed).
| | |
| 0 | substruct
CONTEXT_INFO | In Out |
Substruct to pass information from external clients.
| | |
| 1 | string
CORRELATION_ID | In Out |
Correlation id passed by an external system to Oracle Monetization Cloud.
| | |
| 1 | string
EXTERNAL_USER | In Out |
User of an external system connecting to Oracle Monetization Cloud.
| | | |
| Use | | required |
| | | |
| Class | | /plan |
| | | |
| Class | | /account |
Poid of the plan or account passed in.
| | | |
| Use | | optional |
| | | |
| Class | | /account |
Poid of the modified account object.
This field represents the timestamp at which the event ends. Effective
time of the update to this account, on an external system. If not
specified, the current time on the Oracle Monetization Cloud server will be used.
This would be the timestamp to be used to generate events. If not
specified, the current time on the Oracle Monetization Cloud server will be used.
| | |
| 0 | string
PROGRAM_NAME | In Out |
The name of the program that executed this operation.
| | | |
| Use | | optional |
| | | |
| ElemID mode | | index |
| | | |
| Iteration | | undefined |
| | | |
| Min number of Elements | | 1 |
| | | |
| Allow ELEMID_ANY | | false |
Information to be stored in the account object that was passed in.
Account poid.
Account level deal purchased (if any).
| | |
| 1 | substruct
DEAL_INFO | In Out |
Deal purchased at account level. The DEAL_INFO and PIN_FLD_DEAL_OBJ
are mutually exclusive. Sometimes we may purchase the deal
customized. So, the DEAL_INFO has the entire deal object (the
products and discounts in the deal should be passed) in the
PIN_FLD_DEAL_INFO sub-structure.
Name of the object. Present only if a customized deal is to be
purchased.
Deal description. This is a free text to describe product. Present
only if a customized deal is to be purchased.
Valid start time. Defines valid period for the deal object
(inclusive). Stored as desired time in server timezone. Present
only if a customized deal is to be purchased.
Valid end time. Defines valid period for the deal object
(non-inclusive). Stored as desired time in server timezone. If end
time is zero, valid period does not expire. Present only if a
customized deal is to be purchased.
Flag to indicate on demand bill at the deal level and has value
PIN_DEAL_FLG_BILL_ON_DEMAND for on demand billing. Present only if
a customized deal is to be purchased.
Products Array. Array of products to purchase for the deal. Present
only if a customized deal is to be purchased.
Poid of the product to purchase.
Poid of plan through which product is being purchased.
Poid of purchased product.
This field is common for all product/discount instances
purchased as part of deal or plan purchase. In case of deal
purchase, all products/discounts within the deal will have
the same package id.
In case of plan purchase, all the products/discounts within
the plan, will share the same package id.
Quantity to purchase.
| |
| 0 | NOT_SET |
| |
| 1 | ACTIVE |
| |
| 2 | INACTIVE |
| |
| 3 | CANCELLED |
Status of this subscription product. Possible values are
NOT_SET(0)
ACTIVE(1)
INACTIVE(2)
CANCELLED(3)
Inital status flags. The possible values are: -
PIN_PROD_STATUS_FLAGS_OVERRIDE_PURCHASE_FEE(0x01000000)
PIN_PROD_STATUS_FLAGS_OVERRIDE_CYCLE_FEE(0x02000000)
| | |
| 3 | timestamp
PURCHASE_START_T | In Out |
Purchase start time. Number of seconds into the future relative
to purchase time that product activates (0 means immediately).
| | |
| 3 | int
PURCHASE_START_UNIT | In Out |
For first usage start, the start_unit will be -1. The start date can
be specified in relative units, if it is not set for first usage. The
values can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 3 | int
PURCHASE_START_OFFSET | In Out |
For first usage start, the start_offset will be 0 and relative
offset can be specified for purchase if first usage option is not
marked. To be used in conjunction with unit to calculate
purchase_start_t with reference to the event time.
| | |
| 3 | timestamp
PURCHASE_END_T | In Out |
Purchase end time. Number of seconds into the future relative to
purchase time that product expires (0 means that product does not
expire).
| | |
| 3 | int
PURCHASE_END_UNIT | In Out |
Relative Unit for Purchase can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 3 | int
PURCHASE_END_OFFSET | In Out |
Relative offset for Purchase to be used in conjunction with unit
to calculate purchase end_t.
| | |
| 3 | decimal
PURCHASE_DISCOUNT | In Out |
Purchase discount. The percentage discount applied to
purchase/cancel rates of product.
| | |
| 3 | decimal
PURCHASE_DISC_AMT | In Out |
Fixed amount discount for purchase fees amount of discount
applied to purchase/cancel rates of product.
| | |
| 3 | decimal
PURCHASE_FEE_AMT | In Out |
Purchase fee to be applied for this product. Amount specified
here will override the price specified in the /rate object.
| | |
| 3 | timestamp
CYCLE_START_T | In Out |
Cycle fee start time. Number of seconds into the future relative
to purchase time that cycle fees begin for this product (0 means
immediately).
| | |
| 3 | int
CYCLE_START_UNIT | In Out |
For first usage start, the start_unit will be -1. The start date can
be specified in relative units if it is not set for first usage. The
values can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 3 | int
CYCLE_START_OFFSET | In Out |
For first usage start, the start_offset will be 0 and relative
offset can be specified for cycle if first usage option is not
marked. To be used in conjunction with unit to calculate
cycle_start_t with reference to the event time.
| | |
| 3 | timestamp
CYCLE_END_T | In Out |
Cycle fee end time. Number of seconds into the future relative to
purchase time that cycle fees are no longer applied for this
product (0 means always applied).
| | |
| 3 | int
CYCLE_END_UNIT | In Out |
Relative Unit for Cycle can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 3 | int
CYCLE_END_OFFSET | In Out |
Relative offset for Cycle to be used in conjunction with unit to
calculate cycle end_t.
| | |
| 3 | decimal
CYCLE_DISCOUNT | In Out |
Cycle fee discount. The percent discount applied to cycle rates
of product.
| | |
| 3 | decimal
CYCLE_DISC_AMT | In Out |
Fixed amount discount applied to cycle rates of product.
| | |
| 3 | decimal
CYCLE_FEE_AMT | In Out |
Cycle fee (both forward and arrears) to be applied for this
product. Amount specified here will override the price specified
in the /rate object.
| | |
| 3 | timestamp
USAGE_START_T | In Out |
Usage fee start time. Number of seconds into the future relative
to purchase time that usage fees begin for this product (0 means
immediately).
| | |
| 3 | int
USAGE_START_UNIT | In Out |
For first usage start, this field is -1. Otherwise the start date is
a relative offset, with the unit specified in this field as:
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 3 | int
USAGE_START_OFFSET | In Out |
For first usage, this field is 0. Otherwise, the start date is a
relative offset, which is specified by a combination of this
field and the start unit field.
| | |
| 3 | timestamp
USAGE_END_T | In Out |
Usage fee end time. Number ofseconds into the future relative to
purchase time that usage fees are no longer applied for this
product (0 means always applied).
| | |
| 3 | int
USAGE_END_UNIT | In Out |
Relative unit for Usage can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 3 | int
USAGE_END_OFFSET | In Out |
Relative offset for usage to be used in conjunction with unit to
calculate usage end_t.
| | |
| 3 | decimal
USAGE_DISCOUNT | In Out |
Usage fee discount. The percent discount applied to usage rates
of product.
Description on a per product basis for CSR to add comments.
| | |
| 3 | string
PRICE_LIST_NAME | In Out |
Price list name associated with this offering.
Discounts Array. Array of discounts to purchase for the deal.
Element-id is not significant. Present only if a customized deal is
to be purchased.
Poid of discount to purchase.
Poid of plan through which discount is being purchased.
Poid of purchased discount.
This field is common for all product/discount instances
purchased as part of deal or plan purchase. In case of deal
purchase, all products/discounts within the deal will have
the same package id.
In case of plan purchase, all the products/discounts within
the plan, will share the same package id.
Quantity to purchase.
| |
| 0 | NOT_SET |
| |
| 1 | ACTIVE |
| |
| 2 | INACTIVE |
| |
| 3 | CANCELLED |
Status of this subscription discount. Possible values are
NOT_SET(0)
ACTIVE(1)
INACTIVE(2)
CANCELLED(3)
For later use.
| | |
| 3 | timestamp
PURCHASE_START_T | In Out |
Purchase start time. Number of seconds into the future relative
to purchase time that discount activates.
| | |
| 3 | int
PURCHASE_START_UNIT | In Out |
For first usage start, the start_unit will be -1. The start date can
be specified in relative units if it is not set for first usage. The
values can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 3 | int
PURCHASE_START_OFFSET | In Out |
For first usage start, the start_offset will be 0 and relative
offset can be specified for purchase, if first usage option is
not marked. To be used in conjunction with unit to calculate
purchase_start_t with reference to the event time.
| | |
| 3 | timestamp
PURCHASE_END_T | In Out |
Purchase end time. Number of seconds into the future relative to
purchase time that discount expires (0 means that discount does
not expire).
| | |
| 3 | int
PURCHASE_END_UNIT | In Out |
Relative Unit for Purchase can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 3 | int
PURCHASE_END_OFFSET | In Out |
Relative offset for Purchase to be used in conjunction with unit
to calculate purchase end_t.
| | |
| 3 | timestamp
CYCLE_START_T | In Out |
Cycle fee start time. Number of seconds into the future relative
to purchase time that cycle fees begin for this discount (0 means
immediately).
| | |
| 3 | int
CYCLE_START_UNIT | In Out |
For first usage start, the start_unit will be -1. The start date can
be specified in relative units if it is not set for first usage. The
values can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 3 | int
CYCLE_START_OFFSET | In Out |
For first usage start, the start_offset will be 0 and relative
offset can be specified for purchase, if first usage option is
not marked. To be used in conjunction with unit to calculate
cycle_start_t with reference to the event time.
| | |
| 3 | timestamp
CYCLE_END_T | In Out |
Cycle fee end time. Number of seconds into the future relative to
purchase time that cycle fees are no longer applied for this
discount (0 means always applied).
| | |
| 3 | int
CYCLE_END_UNIT | In Out |
Relative unit for Cycle can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 3 | int
CYCLE_END_OFFSET | In Out |
Relative offset for Cycle to be used in conjunction with unit to
calculate Cycle end_t.
| | |
| 3 | timestamp
USAGE_START_T | In Out |
Usage fee start time. Number of seconds into the future relative
to purchase time that usage fees begin for this discount (0 means
immediately).
| | |
| 3 | int
USAGE_START_UNIT | In Out |
For first usage start, this field is -1. Otherwise the start date is
a relative offset, with the unit specified in this field as:
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 3 | int
USAGE_START_OFFSET | In Out |
For first usage, this field is 0. Otherwise, the start date is a
relative offset, which is specified by a combination of this
field and the start unit field.
| | |
| 3 | timestamp
USAGE_END_T | In Out |
Usage fee end time. Number of seconds into the future relative to
purchase time that usage fees are no longer applied for this
discount (0 means always applied).
| | |
| 3 | int
USAGE_END_UNIT | In Out |
Relative unit for Usage can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 3 | int
USAGE_END_OFFSET | In Out |
Relative offset for Usage to be used in conjunction with unit to
calculate Usage end_t on First Usage.
Description on a per discount basis for CSR to add comments.
Permitted array. Contains type strings for account and service
object types that are permitted to purchase this deal. Each entry
is implicitly appended with a wildcard for checking, so account and
service types that were inherited from a permitted type are also
permitted themselves. No entries implies any account or service
type is permitted to purchase the deal. Element-id is not
significant.
Object type - identifies an allowed account or service object
type.
| | | |
| Use | | optional |
| | | |
| Parent | | out.ACCTINFO |
| | | |
| ElemID mode | | key |
| | | |
| Iteration | | undefined |
| | | |
| Min number of Elements | | 0 |
| | | |
| Max number of Elements | | 1 |
Account level balance group indicator. Here the array does not
contain anything but the element-id is significant. It indicates
which balance group element in the input is account level. It is
recommended to pass in the PIN_FLD_BAL_INFO. If not passed then a
default balance group will be created.
The partial poid of the balance group to be created. During monitor
creation/update, Poid type of /balance_group/monitor is used.
Balance Group name.
The billinfo array element. Here the contents are not significant.
The element id will determine the billinfo that will be associated
with this balance group. if not specified then the first billinfo
that the system finds will be associated with this balance group.
The type only billinfo poid.
| | |
| 3 | poid
BUSINESS_PROFILE_OBJ | In Out |
Business profile poid. Pointer to the Business profile poid to which
this billinfo belongs.
| | |
| 3 | string
BILLINFO_ID | In Out |
This field identifies the billinfo by name.
The Payinfo array. The element-id is significant, but not the
contents. The element-id will be used to identify which payinfo array
to use from the input. If it is not present then the payment method
is considered either as transient or voucher.
The partial poid of payinfo.
| |
| 10001 | Indicates invoice type(PIN_PAY_TYPE_INVOICE). |
| |
| 10003 | Indicates credit card type(PIN_PAY_TYPE_CC). |
| |
| 10005 | Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD). |
| |
| 10007 | Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD). |
| |
| 10018 | Indicates SEPA payment type(PIN_PAY_TYPE_SEPA). |
This represents the type of billing for user.
Payment term ID defines which payment term will be used in the
payment due date calculation.
| | |
| 4 | int
PAYMENT_OFFSET | In Out |
Payment offset value.
| |
| 0x01 | Indicates detail invoice(PIN_INV_TYPE_DETAIL). |
| |
| 0x02 | Indicates summary invoice(PIN_INV_TYPE_SUMMARY). |
| |
| 0x04 | Indicates regular invoice(PIN_INV_TYPE_REGULAR). |
| |
| 0x08 | Indicates subordinate invoice(PIN_INV_TYPE_SUBORDINATE). |
| |
| 0x10 | Indicates parent invoice(PIN_INV_TYPE_PARENT). |
| |
| 0x18 | Indicates parent with subordinates invoice
(PIN_INV_TYPE_PARENT_WITH_SUBORDS). |
| |
| 0x20 | Indicates hierarchy invoice(PIN_INV_TYPE_HIERARCHY). |
| |
| 0x40 | Indicates trial invoice(PIN_INV_TYPE_TRIAL_INVOICE). |
Indicates the type of invoice to be generated.
Partial Flag. This enables the operation to treat some fields
from the request as optional. Values are (0) mandatory,
or (1) optional. The fields affected are:
PIN_FLD_DEBIT_NUM, PIN_FLD_DEBIT_EXP, PIN_FLD_BANK_NO,
PIN_FLD_CITY, PIN_FLD_STATE, PIN_FLD_ZIP and PIN_FLD_COUNTRY.
| | |
| 4 | substruct
INHERITED_INFO | In Out |
All subclass fields for the payinfo object are included in this
substruct. The subclass depends on the pay_type. If pay_type is
invoice then this array element will have PIN_FLD_INV_INFO, etc.
This array element has fields related to invoice type of payment
menthod. There will be only one element and element id is not
significant.
Street address.
City.
Country.
| | |
| 6 | string
DELIVERY_DESCR | In Out |
Delivery mechanism.
| | |
| 6 | enum
DELIVERY_PREFER | In Out |
| |
| 0 | Indicates email delivery(PIN_INV_EMAIL_DELIVERY). |
| |
| 1 | Indicates mail delivery(PIN_INV_USP_DELIVERY). |
| |
| 3 | Indicates fax delivery(PIN_INV_FAX_DELIVERY). |
Prefered delivery method email(0), postal(1) and fax(3).
Comments to appear on each invoice.
Used for invoice terms to be printed on the invoice.
Email address to which invoice be delivered.
Name of party responsible for payment.
State or province.
Zip/Postal code.
This array element has fields related to credit card type of
payment menthod. There will be only one element and element id is
not significant.
Street Address
City.
Country.
Credit card expiration date (mmyy).
Credit card number.
Name as it appears on the credit card.
| | |
| 6 | string
SECURITY_ID | In Out |
Security ID. Used for credit card fraud prevention. This field
stores the 3 digit CVV2 for Visa and 4 digit CID for amex.
State or province.
Zip/Postal code.
This array element has fields related to direct debit type of
payment menthod. There will be only one element and element id is
not significant.
Street Address.
RDFI/Bank ID used for routing transactions.
City.
Country.
Customer's bank account number.
Name as it appears on the card.
State or province.
| |
| 1 | Checking Account type(PIN_ACCOUNT_TYPE_CHECKING). |
| |
| 2 | Savings Account type(PIN_ACCOUNT_TYPE_SAVINGS). |
| |
| 3 | Corporate Account type(PIN_ACCOUNT_TYPE_CORPORATE). |
Bank account type. Checking(1), savings(2) or corporate(3).
Zip/Postal code.
This array element has fields related to SEPA type of
payment method. There will be only one element and element id is
not significant.
| |
| 0 | One-off mandate. |
| |
| 1 | Recurring mandate. |
Mandate type whether it is one-off or recurring.
International Bank Account Number which
is a unique identifier for the bank account.
Bank Identifier Code which is a unique
identifier for the bank related to the account.
| | |
| 6 | string
MANDATE_CONTRACT_ID | In Out |
ID of the underlying contract between the debtor
and the creditor.
| | |
| 6 | string
MANDATE_CONTRACT_DESCR | In Out |
Description of the underlying contract between the debtor
and the creditor.
| | |
| 6 | string
MANDATE_UNIQUE_REFERENCE | In Out |
A unique reference number for the mandate.
| | |
| 6 | timestamp
MANDATE_SIGNED_T | In Out |
Date when the mandate is signed. This cannot be before the account creation date or a future date.
| | |
| 6 | string
MANDATE_SIGNED_PLACE | In Out |
Place where the mandate is signed.
Array to store SEPA compliant customer's bank account details.
Street address of the contact.
City portion of the address.
Country portion of the address.
Name of the contact.
Zipcode.
| | |
| 7 | string
IDENTIFICATION_CODE | In Out |
Debtor identification code.
Name of the Debtor Reference Party.
| | |
| 7 | string
REF_PARTY_ID_CODE | In Out |
Identification code of the Debtor Reference Party.
| | |
| 6 | string
CREDITOR_ID | In Out |
Identification code of the Creditor.
| | |
| 6 | string
CREDITOR_NAME | In Out |
Name of the Creditor.
The balance group info array. The element-id is significant, but not
the contents. The element-id will be used to identify which balance
group array to use from the input. If it is not present then a
default balance group will be created for the billinfo.
| |
| 10001 | Indicates invoice type(PIN_PAY_TYPE_INVOICE). |
| |
| 10003 | Indicates credit card type(PIN_PAY_TYPE_CC). |
| |
| 10005 | Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD). |
| |
| 10007 | Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD). |
| |
| 10018 | |
| |
| 10101 | . |
This represents the type of billing for user.
This flag indicates if this billinfo has subordinates or not. A value
of 0 indicates no subordinates and a value of 1 indicates that it has
subordinates.
Anniversary billing slot.
| | |
| 3 | int
ACTG_FUTURE_DOM | In Out |
New Accounting Close day-of-month (1-31).
| |
| 1 | This represents "open items" type of accounting. With open item
accounting customer's bill does not include amounts from previous
bill, if not paid(PIN_ACTG_TYPE_OPEN_ITEMS). |
| |
| 2 | This represents "balance forward" type of accounting. With balance
forward accounting customer's bill will include amounts from
previous bill, if not paid(PIN_ACTG_TYPE_BALANCE_FORWARD). |
Accounting type of the billinfo. Possible values are
PIN_ACTG_TYPE_OPEN_ITEMS(1) and PIN_ACTG_TYPE_BALANCE_FORWARD(2).This
field is used to allocate items for payment. If not specified, the
configuration entry actg_type is read from pin.conf of CM. If CM's
pin.conf does not have actg_type entry active, then default
accounting type will be balance forward type.
| | |
| 3 | enum
BILLING_STATUS | In Out |
| |
| 0 | Indicates billing status is active(PIN_BILL_ACTIVE). |
| |
| 1 | Indicates billing status is inactive(PIN_BILL_INACTIVE). |
Indicates whether the billinfo should be billed or it should be
suspended for billing.
| | |
| 3 | int
BILLING_STATUS_FLAGS | In Out |
Indicates a reason for setting of the given billing status.
| |
| 10100 | Indicates an active billinfo(PIN_STATUS_ACTIVE). |
| |
| 10102 | Indicates an inactive billinfo(PIN_STATUS_INACTIVE). |
| |
| 10103 | Indicates a closed billinfo(PIN_STATUS_CLOSED). |
Status of the billinfo: active, inactive, or closed.
Indicates a reason for setting of the given status.
It indicates whether this billinfo has a sponsoree.
| 3 | int
SPONSOREE_FLAGS | In Out |
It indicates whether this billinfo has a sponsor.
| | |
| 3 | poid
AR_BILLINFO_OBJ | In Out |
It indicates the AR billinfo for the given billinfo. It can be
present only for a subodinate billinfo.
| | |
| 3 | poid
PARENT_BILLINFO_OBJ | In Out |
It indicates the immediate (one level up) parent. Note that the given
billinfo is not necessarily a subordinate. The parent field may
reflect just child-parent relation. It should be mandatory if moving
to the new parent.
During account creation these values will be derived from the
account. In future when an account can have multiple currencies, the
value specified here will be used.
| | |
| 3 | int
CURRENCY_SECONDARY | In Out |
During account creation these values will be derived from the
account. In future when an account can have multiple currencies, the
value specified here will be used.
| | |
| 3 | enum
BILLING_SEGMENT | In Out |
It indicates the Billing Segment. A billing segment is a user defined
category such as wholesale or retail, that controls the accounting
DOMs to which a bill unit can be assigned.
The POID of Billinfo that this balance group will be associated with.
The fields PIN_FLD_BILLINFO and PIN_FLD_BILLINFO_OBJ are mutually
exclusive. If PIN_FLD_BILLINFO is available then PIN_FLD_BILLINFO_OBJ
will be ignored.
This an optional array to set the credit limit parameters. The
element id is significant and indicates the resource id for which the
limit is being set.
| | |
| 3 | decimal
CREDIT_LIMIT | In Out |
Limit for this resource. Current balance cannot exceed this limit
unless affected by a limit override rate or manually adjusted by a
CSR.
| | |
| 3 | decimal
CREDIT_FLOOR | In Out |
Baseline for calculating percentage for threshold triggers. Credit
limit minus credit floor is 100% of measured range. Credit floor
does NOT enforce any limit on current balance.
| | |
| 3 | decimal
CREDIT_THRESHOLDS_FIXED | In Out |
Limit for this resource. Current balance cannot exceed this limit
unless affected by a limit override rate or manually adjusted by a
CSR.
| | |
| 3 | int
CREDIT_THRESHOLDS | In Out |
Bit flags for triggering when resource balance crosses a boundary
when increasing in value.
| | | |
| Use | | optional |
| | | |
| Parent | | out.ACCTINFO.BAL_INFO.LIMIT |
| | | |
| ElemID mode | | ignored |
| | | |
| Iteration | | undefined |
| | | |
|
Allow ELEMID_ASSIGN
| | true |
| | | |
| Allow ELEMID_ANY | | true |
| | | |
| Recursive | | false |
Array of fixed threshold values.
Fixed threshold value.
Fixed threshold value in Decimal data type
This is an optional array to set the consumption rules for a
resource. The element id is significant and indicates a resource id
for which the limit as well as consumption rules are set.
| | |
| 3 | enum
CONSUMPTION_RULE | In Out |
| |
| 0 | The consumption rule is not defined
(PIN_CONSUMPTION_RULE_UNDEFINED). |
| |
| 1 | Earliest start time. Consume the sub-balance with the earliest
validity start time (earliest valid_from) first
(PIN_CONSUMPTION_RULE_EST). |
| |
| 2 | Latest start time. Consume the sub-balance with the latest
validity start time (latest valid_from) first
(PIN_CONSUMPTION_RULE_LST). |
| |
| 3 | Earliest expiration time. Consume the sub-balance that expires
first (earliest valid_to.)(PIN_CONSUMPTION_RULE_EET) |
| |
| 4 | Latest expiration time. Consume the sub-balance that expires last
(latest valid_to.)(PIN_CONSUMPTION_RULE_LET) |
| |
| 5 | Earliest start time and latest expiration time. Consume the
sub-balance with the earliest valid_from first. If more than one
sub-balances has the same valid_from, consume the one with the
latest valid_to first(PIN_CONSUMPTION_RULE_ESTLET). |
| |
| 6 | Earliest start time and earliest expiration time. Consume the
sub-balance with the earliest valid_from first. If more than one
sub-balances has the same valid_from, consume the one with the
earliest valid_to first(PIN_CONSUMPTION_RULE_ESTEET). |
| |
| 7 | Latest start time and earliest expiration time. Consume the
sub-balance with the latest sub-balance first. If more than one
sub-balances has the same valid_from, consume the one with the
earliest expired sub-balance first(PIN_CONSUMPTION_RULE_LSTEET).
|
| |
| 8 | Latest start time and latest expiration time. Consume the
sub-balance with the latest valid_from first. If more than one
sub-balances has the same valid_from, consume the one with the
latest valid_to first(PIN_CONSUMPTION_RULE_LSTLET). |
| |
| 9 | Earliest expiration time and earliest start time. Consume the
sub-balance with the earliest valid_to first. If more than one
sub-balances has the same valid_to, consume the one with the
earliest valid_from first(PIN_CONSUMPTION_RULE_EETEST). |
| |
| 10 | Earliest expiration time and latest start time. Consume the
sub-balance with the earliest valid_to first. If more than one
sub-balances has the same valid_to, consume the one with the
latest valid_from first(PIN_CONSUMPTION_RULE_EETLST). |
| |
| 11 | Latest expiration time and earliest start time. Consume the
sub-balance with the latest valid_to first. If more than one
sub-balances has the same valid_to, use the one with the earliest
valid_from first(PIN_CONSUMPTION_RULE_LETEST). |
| |
| 12 | Latest expiration time and latest start time. Consume the
sub-balance with the latest valid_to first. If more than one
sub-balances has the same valid_to, use the one with the latest
valid_from first(PIN_CONSUMPTION_RULE_LETLST). |
Consumption rule to be applied on the resource.
The balance group object for the account. Either PIN_FLD_BAL_INFO or
PIN_FLD_BAL_GRP_OBJ must be specified.
This is the primary currency of the account. This acts as element-id
of primary balance element for accounting roll-up. If not provided
the default account currency information will be read from CM's
pin.conf.
| | |
| 1 | int
CURRENCY_SECONDARY | In Out |
The secondary currency of the account. Also this acts as element-id
of secondary balance element for accounting roll-up.
| | | |
| Use | | optional |
| | | |
| ElemID mode | | ignored |
| | | |
| Iteration | | undefined |
| | | |
| Min number of Elements | | 0 |
This represents services array.
The poid of service object created.
| | |
| 1 | int
SUBSCRIPTION_INDEX | In Out |
If this is a member service of a line/subscription, the index points
to the parent/subscription service of the line. The member service
object, when created, will refer the parent/subscription service
using the SUBSCRIPTION_OBJ field. For all other services, the default
is 0.
| | |
| 1 | poid
SUBSCRIPTION_OBJ | In Out |
Subscription service object POID. This is an optional field, and it
refers to the subscription service object of which this service is a
member of.
The billinfo object that this service belongs to.
User defined name for the service. This identifies the service
uniquely within the plan.
| | | |
| Use | | optional |
| | | |
| Parent | | out.SERVICES |
| | | |
| ElemID mode | | key |
| | | |
| Min number of Elements | | 0 |
| | | |
| Max number of Elements | | 1 |
Balance Group array which this service instance is associated to. The
element-id is significant not the contents of the array. The
element-id will be used to identify which balance group array to use
from the input to associate the service to. if not specified the
service will be associated with the account level balance group.
The partial poid of the balance group to be created. During monitor
creation/update, Poid type of /balance_group/monitor is used.
Balance Group name.
The billinfo array element. Here the contents are not significant.
The element id will determine the billinfo that will be associated
with this balance group. if not specified then the first billinfo
that the system finds will be associated with this balance group.
The type only billinfo poid.
| | |
| 3 | poid
BUSINESS_PROFILE_OBJ | In Out |
Business profile poid. Pointer to the Business profile poid to which
this billinfo belongs.
| | |
| 3 | string
BILLINFO_ID | In Out |
This field identifies the billinfo by name.
The Payinfo array. The element-id is significant, but not the
contents. The element-id will be used to identify which payinfo array
to use from the input. If it is not present then the payment method
is considered either as transient or voucher.
The partial poid of payinfo.
| |
| 10001 | Indicates invoice type(PIN_PAY_TYPE_INVOICE). |
| |
| 10003 | Indicates credit card type(PIN_PAY_TYPE_CC). |
| |
| 10005 | Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD). |
| |
| 10007 | Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD). |
| |
| 10018 | Indicates SEPA payment type(PIN_PAY_TYPE_SEPA). |
This represents the type of billing for user.
Payment term ID defines which payment term will be used in the
payment due date calculation.
| | |
| 4 | int
PAYMENT_OFFSET | In Out |
Payment offset value.
| |
| 0x01 | Indicates detail invoice(PIN_INV_TYPE_DETAIL). |
| |
| 0x02 | Indicates summary invoice(PIN_INV_TYPE_SUMMARY). |
| |
| 0x04 | Indicates regular invoice(PIN_INV_TYPE_REGULAR). |
| |
| 0x08 | Indicates subordinate invoice(PIN_INV_TYPE_SUBORDINATE). |
| |
| 0x10 | Indicates parent invoice(PIN_INV_TYPE_PARENT). |
| |
| 0x18 | Indicates parent with subordinates invoice
(PIN_INV_TYPE_PARENT_WITH_SUBORDS). |
| |
| 0x20 | Indicates hierarchy invoice(PIN_INV_TYPE_HIERARCHY). |
| |
| 0x40 | Indicates trial invoice(PIN_INV_TYPE_TRIAL_INVOICE). |
Indicates the type of invoice to be generated.
Partial Flag. This enables the operation to treat some fields
from the request as optional. Values are (0) mandatory,
or (1) optional. The fields affected are:
PIN_FLD_DEBIT_NUM, PIN_FLD_DEBIT_EXP, PIN_FLD_BANK_NO,
PIN_FLD_CITY, PIN_FLD_STATE, PIN_FLD_ZIP and PIN_FLD_COUNTRY.
| | |
| 4 | substruct
INHERITED_INFO | In Out |
All subclass fields for the payinfo object are included in this
substruct. The subclass depends on the pay_type. If pay_type is
invoice then this array element will have PIN_FLD_INV_INFO, etc.
This array element has fields related to invoice type of payment
menthod. There will be only one element and element id is not
significant.
Street address.
City.
Country.
| | |
| 6 | string
DELIVERY_DESCR | In Out |
Delivery mechanism.
| | |
| 6 | enum
DELIVERY_PREFER | In Out |
| |
| 0 | Indicates email delivery(PIN_INV_EMAIL_DELIVERY). |
| |
| 1 | Indicates mail delivery(PIN_INV_USP_DELIVERY). |
| |
| 3 | Indicates fax delivery(PIN_INV_FAX_DELIVERY). |
Prefered delivery method email(0), postal(1) and fax(3).
Comments to appear on each invoice.
Used for invoice terms to be printed on the invoice.
Email address to which invoice be delivered.
Name of party responsible for payment.
State or province.
Zip/Postal code.
This array element has fields related to credit card type of
payment menthod. There will be only one element and element id is
not significant.
Street Address
City.
Country.
Credit card expiration date (mmyy).
Credit card number.
Name as it appears on the credit card.
| | |
| 6 | string
SECURITY_ID | In Out |
Security ID. Used for credit card fraud prevention. This field
stores the 3 digit CVV2 for Visa and 4 digit CID for amex.
State or province.
Zip/Postal code.
This array element has fields related to direct debit type of
payment menthod. There will be only one element and element id is
not significant.
Street Address.
RDFI/Bank ID used for routing transactions.
City.
Country.
Customer's bank account number.
Name as it appears on the card.
State or province.
| |
| 1 | Checking Account type(PIN_ACCOUNT_TYPE_CHECKING). |
| |
| 2 | Savings Account type(PIN_ACCOUNT_TYPE_SAVINGS). |
| |
| 3 | Corporate Account type(PIN_ACCOUNT_TYPE_CORPORATE). |
Bank account type. Checking(1), savings(2) or corporate(3).
Zip/Postal code.
This array element has fields related to SEPA type of
payment method. There will be only one element and element id is
not significant.
| |
| 0 | One-off mandate. |
| |
| 1 | Recurring mandate. |
Mandate type whether it is one-off or recurring.
International Bank Account Number which
is a unique identifier for the bank account.
Bank Identifier Code which is a unique
identifier for the bank related to the account.
| | |
| 6 | string
MANDATE_CONTRACT_ID | In Out |
ID of the underlying contract between the debtor
and the creditor.
| | |
| 6 | string
MANDATE_CONTRACT_DESCR | In Out |
Description of the underlying contract between the debtor
and the creditor.
| | |
| 6 | string
MANDATE_UNIQUE_REFERENCE | In Out |
A unique reference number for the mandate.
| | |
| 6 | timestamp
MANDATE_SIGNED_T | In Out |
Date when the mandate is signed. This cannot be before the account creation date or a future date.
| | |
| 6 | string
MANDATE_SIGNED_PLACE | In Out |
Place where the mandate is signed.
Array to store SEPA compliant customer's bank account details.
Street address of the contact.
City portion of the address.
Country portion of the address.
Name of the contact.
Zipcode.
| | |
| 7 | string
IDENTIFICATION_CODE | In Out |
Debtor identification code.
Name of the Debtor Reference Party.
| | |
| 7 | string
REF_PARTY_ID_CODE | In Out |
Identification code of the Debtor Reference Party.
| | |
| 6 | string
CREDITOR_ID | In Out |
Identification code of the Creditor.
| | |
| 6 | string
CREDITOR_NAME | In Out |
Name of the Creditor.
The balance group info array. The element-id is significant, but not
the contents. The element-id will be used to identify which balance
group array to use from the input. If it is not present then a
default balance group will be created for the billinfo.
| |
| 10001 | Indicates invoice type(PIN_PAY_TYPE_INVOICE). |
| |
| 10003 | Indicates credit card type(PIN_PAY_TYPE_CC). |
| |
| 10005 | Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD). |
| |
| 10007 | Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD). |
| |
| 10018 | |
| |
| 10101 | . |
This represents the type of billing for user.
This flag indicates if this billinfo has subordinates or not. A value
of 0 indicates no subordinates and a value of 1 indicates that it has
subordinates.
Anniversary billing slot.
| | |
| 3 | int
ACTG_FUTURE_DOM | In Out |
New Accounting Close day-of-month (1-31).
| |
| 1 | This represents "open items" type of accounting. With open item
accounting customer's bill does not include amounts from previous
bill, if not paid(PIN_ACTG_TYPE_OPEN_ITEMS). |
| |
| 2 | This represents "balance forward" type of accounting. With balance
forward accounting customer's bill will include amounts from
previous bill, if not paid(PIN_ACTG_TYPE_BALANCE_FORWARD). |
Accounting type of the billinfo. Possible values are
PIN_ACTG_TYPE_OPEN_ITEMS(1) and PIN_ACTG_TYPE_BALANCE_FORWARD(2).This
field is used to allocate items for payment. If not specified, the
configuration entry actg_type is read from pin.conf of CM. If CM's
pin.conf does not have actg_type entry active, then default
accounting type will be balance forward type.
| | |
| 3 | enum
BILLING_STATUS | In Out |
| |
| 0 | Indicates billing status is active(PIN_BILL_ACTIVE). |
| |
| 1 | Indicates billing status is inactive(PIN_BILL_INACTIVE). |
Indicates whether the billinfo should be billed or it should be
suspended for billing.
| | |
| 3 | int
BILLING_STATUS_FLAGS | In Out |
Indicates a reason for setting of the given billing status.
| |
| 10100 | Indicates an active billinfo(PIN_STATUS_ACTIVE). |
| |
| 10102 | Indicates an inactive billinfo(PIN_STATUS_INACTIVE). |
| |
| 10103 | Indicates a closed billinfo(PIN_STATUS_CLOSED). |
Status of the billinfo: active, inactive, or closed.
Indicates a reason for setting of the given status.
It indicates whether this billinfo has a sponsoree.
| 3 | int
SPONSOREE_FLAGS | In Out |
It indicates whether this billinfo has a sponsor.
| | |
| 3 | poid
AR_BILLINFO_OBJ | In Out |
It indicates the AR billinfo for the given billinfo. It can be
present only for a subodinate billinfo.
| | |
| 3 | poid
PARENT_BILLINFO_OBJ | In Out |
It indicates the immediate (one level up) parent. Note that the given
billinfo is not necessarily a subordinate. The parent field may
reflect just child-parent relation. It should be mandatory if moving
to the new parent.
During account creation these values will be derived from the
account. In future when an account can have multiple currencies, the
value specified here will be used.
| | |
| 3 | int
CURRENCY_SECONDARY | In Out |
During account creation these values will be derived from the
account. In future when an account can have multiple currencies, the
value specified here will be used.
| | |
| 3 | enum
BILLING_SEGMENT | In Out |
It indicates the Billing Segment. A billing segment is a user defined
category such as wholesale or retail, that controls the accounting
DOMs to which a bill unit can be assigned.
The POID of Billinfo that this balance group will be associated with.
The fields PIN_FLD_BILLINFO and PIN_FLD_BILLINFO_OBJ are mutually
exclusive. If PIN_FLD_BILLINFO is available then PIN_FLD_BILLINFO_OBJ
will be ignored.
This an optional array to set the credit limit parameters. The
element id is significant and indicates the resource id for which the
limit is being set.
| | |
| 3 | decimal
CREDIT_LIMIT | In Out |
Limit for this resource. Current balance cannot exceed this limit
unless affected by a limit override rate or manually adjusted by a
CSR.
| | |
| 3 | decimal
CREDIT_FLOOR | In Out |
Baseline for calculating percentage for threshold triggers. Credit
limit minus credit floor is 100% of measured range. Credit floor
does NOT enforce any limit on current balance.
| | |
| 3 | decimal
CREDIT_THRESHOLDS_FIXED | In Out |
Limit for this resource. Current balance cannot exceed this limit
unless affected by a limit override rate or manually adjusted by a
CSR.
| | |
| 3 | int
CREDIT_THRESHOLDS | In Out |
Bit flags for triggering when resource balance crosses a boundary
when increasing in value.
| | | |
| Use | | optional |
| | | |
| Parent | | out.SERVICES.BAL_INFO.LIMIT |
| | | |
| ElemID mode | | ignored |
| | | |
| Iteration | | undefined |
| | | |
|
Allow ELEMID_ASSIGN
| | true |
| | | |
| Allow ELEMID_ANY | | true |
| | | |
| Recursive | | false |
Array of fixed threshold values.
Fixed threshold value.
Fixed threshold value in Decimal data type
This is an optional array to set the consumption rules for a
resource. The element id is significant and indicates a resource id
for which the limit as well as consumption rules are set.
| | |
| 3 | enum
CONSUMPTION_RULE | In Out |
| |
| 0 | The consumption rule is not defined
(PIN_CONSUMPTION_RULE_UNDEFINED). |
| |
| 1 | Earliest start time. Consume the sub-balance with the earliest
validity start time (earliest valid_from) first
(PIN_CONSUMPTION_RULE_EST). |
| |
| 2 | Latest start time. Consume the sub-balance with the latest
validity start time (latest valid_from) first
(PIN_CONSUMPTION_RULE_LST). |
| |
| 3 | Earliest expiration time. Consume the sub-balance that expires
first (earliest valid_to.)(PIN_CONSUMPTION_RULE_EET) |
| |
| 4 | Latest expiration time. Consume the sub-balance that expires last
(latest valid_to.)(PIN_CONSUMPTION_RULE_LET) |
| |
| 5 | Earliest start time and latest expiration time. Consume the
sub-balance with the earliest valid_from first. If more than one
sub-balances has the same valid_from, consume the one with the
latest valid_to first(PIN_CONSUMPTION_RULE_ESTLET). |
| |
| 6 | Earliest start time and earliest expiration time. Consume the
sub-balance with the earliest valid_from first. If more than one
sub-balances has the same valid_from, consume the one with the
earliest valid_to first(PIN_CONSUMPTION_RULE_ESTEET). |
| |
| 7 | Latest start time and earliest expiration time. Consume the
sub-balance with the latest sub-balance first. If more than one
sub-balances has the same valid_from, consume the one with the
earliest expired sub-balance first(PIN_CONSUMPTION_RULE_LSTEET).
|
| |
| 8 | Latest start time and latest expiration time. Consume the
sub-balance with the latest valid_from first. If more than one
sub-balances has the same valid_from, consume the one with the
latest valid_to first(PIN_CONSUMPTION_RULE_LSTLET). |
| |
| 9 | Earliest expiration time and earliest start time. Consume the
sub-balance with the earliest valid_to first. If more than one
sub-balances has the same valid_to, consume the one with the
earliest valid_from first(PIN_CONSUMPTION_RULE_EETEST). |
| |
| 10 | Earliest expiration time and latest start time. Consume the
sub-balance with the earliest valid_to first. If more than one
sub-balances has the same valid_to, consume the one with the
latest valid_from first(PIN_CONSUMPTION_RULE_EETLST). |
| |
| 11 | Latest expiration time and earliest start time. Consume the
sub-balance with the latest valid_to first. If more than one
sub-balances has the same valid_to, use the one with the earliest
valid_from first(PIN_CONSUMPTION_RULE_LETEST). |
| |
| 12 | Latest expiration time and latest start time. Consume the
sub-balance with the latest valid_to first. If more than one
sub-balances has the same valid_to, use the one with the latest
valid_from first(PIN_CONSUMPTION_RULE_LETLST). |
Consumption rule to be applied on the resource.
The balance group object for the service. Either PIN_FLD_BAL_INFO or
PIN_FLD_BAL_GRP_OBJ must be specified. If PIN_FLD_BAL_INFO is passed
in, this field will be ignored.
Login for service object.
| | | |
| Use | | optional |
| | | |
| Parent | | out.SERVICES |
| | | |
| ElemID mode | | index |
| | | |
| Min number of Elements | | 0 |
The array of new aliases.
The alias.
| | |
| 1 | enum
PASSWD_STATUS | In Out |
| |
| 0 | The password status is valid and normal
(PIN_SERV_PASSWDSTATUS_NORMAL). |
| |
| 1 | The password status is valid and is temporary
(PIN_SERV_PASSWDSTATUS_TEMPORARY). |
| |
| 2 | The password status is "expires" (PIN_SERV_PASSWDSTATUS_EXPIRES). |
| |
| 3 | The password status is invalid(PIN_SERV_PASSWDSTATUS_INVALID). |
Desired password status. The possible values are NORMAL(0), TEMP(1),
EXPIRES(2), INVALID(3).
Deal that service object purchased (if any). This is for backward
compatibility for the Plan not having PIN_FLD_DEALS array.
| | |
| 1 | substruct
DEAL_INFO | In Out |
Deal purchased at service level. The DEAL_INFO and PIN_FLD_DEAL_OBJ
are mutually exclusive. Sometimes we may purchase the deal
customized. So, the DEAL_INFO has the entire deal object (the
products and discounts in the deal should be passed) in the
PIN_FLD_DEAL_INFO sub-structure.
Name of the object. Present only if a customized deal is to be
purchased.
Deal description. This is a free text to describe product. Present
only if a customized deal is to be purchased.
Valid start time. Defines valid period for the deal object
(inclusive). Stored as desired time in server timezone. Present
only if a customized deal is to be purchased.
Valid end time. Defines valid period for the deal object
(non-inclusive). Stored as desired time in server timezone. If end
time is zero, valid period does not expire. Present only if a
customized deal is to be purchased.
Flag to indicate on demand bill at the deal level and has value
PIN_DEAL_FLG_BILL_ON_DEMAND for on demand billing. Present only if
a customized deal is to be purchased.
Products Array. Array of products to purchase for the deal. Present
only if a customized deal is to be purchased.
Poid of the product to purchase.
Poid of plan through which product is being purchased.
Poid of purchased product.
This field is common for all product/discount instances
purchased as part of deal or plan purchase. In case of deal
purchase, all products/discounts within the deal will have
the same package id.
In case of plan purchase, all the products/discounts within
the plan, will share the same package id.
Quantity to purchase.
| |
| 0 | NOT_SET |
| |
| 1 | ACTIVE |
| |
| 2 | INACTIVE |
| |
| 3 | CANCELLED |
Status of this subscription product. Possible values are
NOT_SET(0)
ACTIVE(1)
INACTIVE(2)
CANCELLED(3)
Inital status flags. The possible values are: -
PIN_PROD_STATUS_FLAGS_OVERRIDE_PURCHASE_FEE(0x01000000)
PIN_PROD_STATUS_FLAGS_OVERRIDE_CYCLE_FEE(0x02000000)
| | |
| 3 | timestamp
PURCHASE_START_T | In Out |
Purchase start time. Number of seconds into the future relative
to purchase time that product activates (0 means immediately).
| | |
| 3 | int
PURCHASE_START_UNIT | In Out |
For first usage start, the start_unit will be -1. The start date can
be specified in relative units, if it is not set for first usage. The
values can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 3 | int
PURCHASE_START_OFFSET | In Out |
For first usage start, the start_offset will be 0 and relative
offset can be specified for purchase if first usage option is not
marked. To be used in conjunction with unit to calculate
purchase_start_t with reference to the event time.
| | |
| 3 | timestamp
PURCHASE_END_T | In Out |
Purchase end time. Number of seconds into the future relative to
purchase time that product expires (0 means that product does not
expire).
| | |
| 3 | int
PURCHASE_END_UNIT | In Out |
Relative Unit for Purchase can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 3 | int
PURCHASE_END_OFFSET | In Out |
Relative offset for Purchase to be used in conjunction with unit
to calculate purchase end_t.
| | |
| 3 | decimal
PURCHASE_DISCOUNT | In Out |
Purchase discount. The percentage discount applied to
purchase/cancel rates of product.
| | |
| 3 | decimal
PURCHASE_DISC_AMT | In Out |
Fixed amount discount for purchase fees amount of discount
applied to purchase/cancel rates of product.
| | |
| 3 | decimal
PURCHASE_FEE_AMT | In Out |
Purchase fee to be applied for this product. Amount specified
here will override the price specified in the /rate object.
| | |
| 3 | timestamp
CYCLE_START_T | In Out |
Cycle fee start time. Number of seconds into the future relative
to purchase time that cycle fees begin for this product (0 means
immediately).
| | |
| 3 | int
CYCLE_START_UNIT | In Out |
For first usage start, the start_unit will be -1. The start date can
be specified in relative units if it is not set for first usage. The
values can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 3 | int
CYCLE_START_OFFSET | In Out |
For first usage start, the start_offset will be 0 and relative
offset can be specified for cycle if first usage option is not
marked. To be used in conjunction with unit to calculate
cycle_start_t with reference to the event time.
| | |
| 3 | timestamp
CYCLE_END_T | In Out |
Cycle fee end time. Number of seconds into the future relative to
purchase time that cycle fees are no longer applied for this
product (0 means always applied).
| | |
| 3 | int
CYCLE_END_UNIT | In Out |
Relative Unit for Cycle can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 3 | int
CYCLE_END_OFFSET | In Out |
Relative offset for Cycle to be used in conjunction with unit to
calculate cycle end_t.
| | |
| 3 | decimal
CYCLE_DISCOUNT | In Out |
Cycle fee discount. The percent discount applied to cycle rates
of product.
| | |
| 3 | decimal
CYCLE_DISC_AMT | In Out |
Fixed amount discount applied to cycle rates of product.
| | |
| 3 | decimal
CYCLE_FEE_AMT | In Out |
Cycle fee (both forward and arrears) to be applied for this
product. Amount specified here will override the price specified
in the /rate object.
| | |
| 3 | timestamp
USAGE_START_T | In Out |
Usage fee start time. Number of seconds into the future relative
to purchase time that usage fees begin for this product (0 means
immediately).
| | |
| 3 | int
USAGE_START_UNIT | In Out |
For first usage start, this field is -1. Otherwise the start date is
a relative offset, with the unit specified in this field as:
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 3 | int
USAGE_START_OFFSET | In Out |
For first usage, this field is 0. Otherwise, the start date is a
relative offset, which is specified by a combination of this
field and the start unit field.
| | |
| 3 | timestamp
USAGE_END_T | In Out |
Usage fee end time. Number ofseconds into the future relative to
purchase time that usage fees are no longer applied for this
product (0 means always applied).
| | |
| 3 | int
USAGE_END_UNIT | In Out |
Relative unit for Usage can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 3 | int
USAGE_END_OFFSET | In Out |
Relative offset for usage to be used in conjunction with unit to
calculate usage end_t.
| | |
| 3 | decimal
USAGE_DISCOUNT | In Out |
Usage fee discount. The percent discount applied to usage rates
of product.
Description on a per product basis for CSR to add comments.
| | |
| 3 | string
PRICE_LIST_NAME | In Out |
Price list name associated with this offering.
Discounts Array. Array of discounts to purchase for the deal.
Element-id is not significant. Present only if a customized deal is
to be purchased.
Poid of discount to purchase.
Poid of plan through which discount is being purchased.
Poid of purchased discount.
This field is common for all product/discount instances
purchased as part of deal or plan purchase. In case of deal
purchase, all products/discounts within the deal will have
the same package id.
In case of plan purchase, all the products/discounts within
the plan, will share the same package id.
Quantity to purchase.
| |
| 0 | NOT_SET |
| |
| 1 | ACTIVE |
| |
| 2 | INACTIVE |
| |
| 3 | CANCELLED |
Status of this subscription discount. Possible values are
NOT_SET(0)
ACTIVE(1)
INACTIVE(2)
CANCELLED(3)
For later use.
| | |
| 3 | timestamp
PURCHASE_START_T | In Out |
Purchase start time. Number of seconds into the future relative
to purchase time that discount activates.
| | |
| 3 | int
PURCHASE_START_UNIT | In Out |
For first usage start, the start_unit will be -1. The start date can
be specified in relative units if it is not set for first usage. The
values can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 3 | int
PURCHASE_START_OFFSET | In Out |
For first usage start, the start_offset will be 0 and relative
offset can be specified for purchase, if first usage option is
not marked. To be used in conjunction with unit to calculate
purchase_start_t with reference to the event time.
| | |
| 3 | timestamp
PURCHASE_END_T | In Out |
Purchase end time. Number of seconds into the future relative to
purchase time that discount expires (0 means that discount does
not expire).
| | |
| 3 | int
PURCHASE_END_UNIT | In Out |
Relative Unit for Purchase can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 3 | int
PURCHASE_END_OFFSET | In Out |
Relative offset for Purchase to be used in conjunction with unit
to calculate purchase end_t.
| | |
| 3 | timestamp
CYCLE_START_T | In Out |
Cycle fee start time. Number of seconds into the future relative
to purchase time that cycle fees begin for this discount (0 means
immediately).
| | |
| 3 | int
CYCLE_START_UNIT | In Out |
For first usage start, the start_unit will be -1. The start date can
be specified in relative units if it is not set for first usage. The
values can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 3 | int
CYCLE_START_OFFSET | In Out |
For first usage start, the start_offset will be 0 and relative
offset can be specified for purchase, if first usage option is
not marked. To be used in conjunction with unit to calculate
cycle_start_t with reference to the event time.
| | |
| 3 | timestamp
CYCLE_END_T | In Out |
Cycle fee end time. Number of seconds into the future relative to
purchase time that cycle fees are no longer applied for this
discount (0 means always applied).
| | |
| 3 | int
CYCLE_END_UNIT | In Out |
Relative unit for Cycle can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 3 | int
CYCLE_END_OFFSET | In Out |
Relative offset for Cycle to be used in conjunction with unit to
calculate Cycle end_t.
| | |
| 3 | timestamp
USAGE_START_T | In Out |
Usage fee start time. Number of seconds into the future relative
to purchase time that usage fees begin for this discount (0 means
immediately).
| | |
| 3 | int
USAGE_START_UNIT | In Out |
For first usage start, this field is -1. Otherwise the start date is
a relative offset, with the unit specified in this field as:
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 3 | int
USAGE_START_OFFSET | In Out |
For first usage, this field is 0. Otherwise, the start date is a
relative offset, which is specified by a combination of this
field and the start unit field.
| | |
| 3 | timestamp
USAGE_END_T | In Out |
Usage fee end time. Number of seconds into the future relative to
purchase time that usage fees are no longer applied for this
discount (0 means always applied).
| | |
| 3 | int
USAGE_END_UNIT | In Out |
Relative unit for Usage can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 3 | int
USAGE_END_OFFSET | In Out |
Relative offset for Usage to be used in conjunction with unit to
calculate Usage end_t on First Usage.
Description on a per discount basis for CSR to add comments.
Permitted array. Contains type strings for account and service
object types that are permitted to purchase this deal. Each entry
is implicitly appended with a wildcard for checking, so account and
service types that were inherited from a permitted type are also
permitted themselves. No entries implies any account or service
type is permitted to purchase the deal. Element-id is not
significant.
Object type - identifies an allowed account or service object
type.
| | | |
| Use | | optional |
| | | |
| Parent | | out.SERVICES |
| | | |
| ElemID mode | | ignored |
| | | |
| Iteration | | undefined |
| | | |
| Min number of Elements | | 0 |
This is the array of deals that this service purchases.
It indicates the deal poid that will be purchased without
customization.
| |
| 0 | PIN_PRICE_DEAL_OPTIONAL |
| |
| 1 | PIN_PRICE_DEAL_REQUIRED |
Deal option type. Required only if a valid service id is provided.
| | |
| 2 | substruct
DEAL_INFO | In Out |
Deal purchased at service level. The DEAL_INFO and PIN_FLD_DEAL_OBJ
are mutually exclusive. Sometimes we may purchase the deal
customized. So, the DEAL_INFO has the entire deal object (the
products and discounts in the deal should be passed) in the
PIN_FLD_DEAL_INFO sub-structure.
Name of the object. Present only if a customized deal is to be
purchased.
Deal description. This is a free text to describe product.
Present only if a customized deal is to be purchased.
Valid start time. Defines valid period for the deal object
(inclusive). Stored as desired time in server timezone. Present
only if a customized deal is to be purchased.
Valid end time. Defines valid period for the deal object
(non-inclusive). Stored as desired time in server timezone. If
end time is zero, valid period does not expire. Present only if a
customized deal is to be purchased.
Flag to indicate on demand bill at the deal level and has value
PIN_DEAL_FLG_BILL_ON_DEMAND for on demand billing. Present only
if a customized deal is to be purchased.
Products Array. Array of products to purchase for the deal.
Present only if a customized deal is to be purchased.
Poid of the product to purchase.
Poid of plan through which product is being purchased.
Poid of purchased product.
This field is common for all product/discount instances
purchased as part of deal or plan purchase. In case of deal
purchase, all products/discounts within the deal will have
the same package id.
In case of plan purchase, all the products/discounts within
the plan, will share the same package id.
Quantity to purchase.
| |
| 0 | NOT_SET |
| |
| 1 | ACTIVE |
| |
| 2 | INACTIVE |
| |
| 3 | CANCELLED |
Status of this subscription product. Possible values are
NOT_SET(0)
ACTIVE(1)
INACTIVE(2)
CANCELLED(3)
Inital status flags. The possible values are: -
PIN_PROD_STATUS_FLAGS_OVERRIDE_PURCHASE_FEE(0x01000000)
PIN_PROD_STATUS_FLAGS_OVERRIDE_CYCLE_FEE(0x02000000)
| | |
| 4 | timestamp
PURCHASE_START_T | In Out |
Purchase start time. Number of seconds into the future relative
to purchase time that product activates (0 means immediately).
| | |
| 4 | int
PURCHASE_START_UNIT | In Out |
For first usage start, the start_unit will be -1. The start date
can be specified in relative units, if it is not set for first
usage. The values can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 4 | int
PURCHASE_START_OFFSET | In Out |
For first usage start, the start_offset will be 0 and relative
offset can be specified for purchase if first usage option is
not marked. To be used in conjunction with unit to calculate
purchase_start_t with reference to the event time.
| | |
| 4 | timestamp
PURCHASE_END_T | In Out |
Purchase end time. Number of seconds into the future relative
to purchase time that product expires (0 means that product
does not expire).
| | |
| 4 | int
PURCHASE_END_UNIT | In Out |
Relative Unit for Purchase can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 4 | int
PURCHASE_END_OFFSET | In Out |
Relative offset for Purchase to be used in conjunction with
unit to calculate purchase end_t.
| | |
| 4 | decimal
PURCHASE_DISCOUNT | In Out |
Purchase discount. The percentage discount applied to
purchase/cancel rates of product.
| | |
| 4 | decimal
PURCHASE_DISC_AMT | In Out |
Fixed amount discount for purchase fees amount of discount
applied to purchase/cancel rates of product.
| | |
| 4 | decimal
PURCHASE_FEE_AMT | In Out |
Purchase fee to be applied for this product. Amount specified
here will override the price specified in the /rate object.
| | |
| 4 | timestamp
CYCLE_START_T | In Out |
Cycle fee start time. Number of seconds into the future
relative to purchase time that cycle fees begin for this
product (0 means immediately).
| | |
| 4 | int
CYCLE_START_UNIT | In Out |
For first usage start, the start_unit will be -1. The start date
can be specified in relative units if it is not set for first
usage. The values can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 4 | int
CYCLE_START_OFFSET | In Out |
For first usage start, the start_offset will be 0 and relative
offset can be specified for cycle if first usage option is not
marked. To be used in conjunction with unit to calculate
cycle_start_t with reference to the event time.
| | |
| 4 | timestamp
CYCLE_END_T | In Out |
Cycle fee end time. Number of seconds into the future relative
to purchase time that cycle fees are no longer applied for this
product (0 means always applied).
| | |
| 4 | int
CYCLE_END_UNIT | In Out |
Relative Unit for Cycle can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 4 | int
CYCLE_END_OFFSET | In Out |
Relative offset for Cycle to be used in conjunction with unit
to calculate cycle end_t.
| | |
| 4 | decimal
CYCLE_DISCOUNT | In Out |
Cycle fee discount. The percent discount applied to cycle rates
of product.
| | |
| 4 | decimal
CYCLE_DISC_AMT | In Out |
Fixed amount discount applied to cycle rates of product.
| | |
| 4 | decimal
CYCLE_FEE_AMT | In Out |
Cycle fee (both forward and arrears) to be applied for this
product. Amount specified here will override the price
specified in the /rate object.
| | |
| 4 | timestamp
USAGE_START_T | In Out |
Usage fee start time. Number of seconds into the future
relative to purchase time that usage fees begin for this
product (0 means immediately).
| | |
| 4 | int
USAGE_START_UNIT | In Out |
For first usage start, this field is -1. Otherwise the start date
is a relative offset, with the unit specified in this field as:
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 4 | int
USAGE_START_OFFSET | In Out |
For first usage, this field is 0. Otherwise, the start date is
a relative offset, which is specified by a combination of this
field and the start unit field.
| | |
| 4 | timestamp
USAGE_END_T | In Out |
Usage fee end time. Number ofseconds into the future relative
to purchase time that usage fees are no longer applied for this
product (0 means always applied).
| | |
| 4 | int
USAGE_END_UNIT | In Out |
Relative unit for Usage can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 4 | int
USAGE_END_OFFSET | In Out |
Relative offset for usage to be used in conjunction with unit
to calculate usage end_t.
| | |
| 4 | decimal
USAGE_DISCOUNT | In Out |
Usage fee discount. The percent discount applied to usage rates
of product.
Description on a per product basis for CSR to add comments.
| | |
| 4 | string
PRICE_LIST_NAME | In Out |
Price list name associated with this offering.
Discounts Array. Array of discounts to purchase for the deal.
Element-id is not significant. Present only if a customized deal
is to be purchased.
Poid of discount to purchase.
Poid of plan through which discount is being purchased.
Poid of purchased discount.
This field is common for all product/discount instances
purchased as part of deal or plan purchase. In case of deal
purchase, all products/discounts within the deal will have
the same package id.
In case of plan purchase, all the products/discounts within
the plan, will share the same package id.
Quantity to purchase.
| |
| 0 | NOT_SET |
| |
| 1 | ACTIVE |
| |
| 2 | INACTIVE |
| |
| 3 | CANCELLED |
Status of this subscription discount. Possible values are
NOT_SET(0)
ACTIVE(1)
INACTIVE(2)
CANCELLED(3)
For later use.
| | |
| 4 | timestamp
PURCHASE_START_T | In Out |
Purchase start time. Number of seconds into the future relative
to purchase time that discount activates.
| | |
| 4 | int
PURCHASE_START_UNIT | In Out |
For first usage start, the start_unit will be -1. The start date
can be specified in relative units if it is not set for first
usage. The values can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 4 | int
PURCHASE_START_OFFSET | In Out |
For first usage start, the start_offset will be 0 and relative
offset can be specified for purchase, if first usage option is
not marked. To be used in conjunction with unit to calculate
purchase_start_t with reference to the event time.
| | |
| 4 | timestamp
PURCHASE_END_T | In Out |
Purchase end time. Number of seconds into the future relative
to purchase time that discount expires (0 means that discount
does not expire).
| | |
| 4 | int
PURCHASE_END_UNIT | In Out |
Relative Unit for Purchase can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 4 | int
PURCHASE_END_OFFSET | In Out |
Relative offset for Purchase to be used in conjunction with
unit to calculate purchase end_t.
| | |
| 4 | timestamp
CYCLE_START_T | In Out |
Cycle fee start time. Number of seconds into the future
relative to purchase time that cycle fees begin for this
discount (0 means immediately).
| | |
| 4 | int
CYCLE_START_UNIT | In Out |
For first usage start, the start_unit will be -1. The start date
can be specified in relative units if it is not set for first
usage. The values can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 4 | int
CYCLE_START_OFFSET | In Out |
For first usage start, the start_offset will be 0 and relative
offset can be specified for purchase, if first usage option is
not marked. To be used in conjunction with unit to calculate
cycle_start_t with reference to the event time.
| | |
| 4 | timestamp
CYCLE_END_T | In Out |
Cycle fee end time. Number of seconds into the future relative
to purchase time that cycle fees are no longer applied for this
discount (0 means always applied).
| | |
| 4 | int
CYCLE_END_UNIT | In Out |
Relative unit for Cycle can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 4 | int
CYCLE_END_OFFSET | In Out |
Relative offset for Cycle to be used in conjunction with unit
to calculate Cycle end_t.
| | |
| 4 | timestamp
USAGE_START_T | In Out |
Usage fee start time. Number of seconds into the future
relative to purchase time that usage fees begin for this
discount (0 means immediately).
| | |
| 4 | int
USAGE_START_UNIT | In Out |
For first usage start, this field is -1. Otherwise the start date
is a relative offset, with the unit specified in this field as:
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 4 | int
USAGE_START_OFFSET | In Out |
For first usage, this field is 0. Otherwise, the start date is
a relative offset, which is specified by a combination of this
field and the start unit field.
| | |
| 4 | timestamp
USAGE_END_T | In Out |
Usage fee end time. Number of seconds into the future relative
to purchase time that usage fees are no longer applied for this
discount (0 means always applied).
| | |
| 4 | int
USAGE_END_UNIT | In Out |
Relative unit for Usage can be
Seconds(1)
Minutes(2)
Hours(3)
Days(4)
Months(5)
Act Cycles(8)
| | |
| 4 | int
USAGE_END_OFFSET | In Out |
Relative offset for Usage to be used in conjunction with unit
to calculate Usage end_t on First Usage.
Description on a per discount basis for CSR to add comments.
Permitted array. Contains type strings for account and service
object types that are permitted to purchase this deal. Each entry
is implicitly appended with a wildcard for checking, so account
and service types that were inherited from a permitted type are
also permitted themselves. No entries implies any account or
service type is permitted to purchase the deal. Element-id is not
significant.
Object type - identifies an allowed account or service object
type.
| | | |
| Use | | optional |
| | | |
| Parent | | out.SERVICES |
| | | |
| Min number of Elements | | 0 |
| | | |
| Max number of Elements | | 1 |
Desired Status Info - if not specified, an active service is created.
The element-id is not significant.
| |
| 10100 | Indicates an active service(PIN_STATUS_ACTIVE). |
| |
| 10102 | Indicates an inactive service(PIN_STATUS_INACTIVE). |
| |
| 10103 | Indicates a closed service(PIN_STATUS_CLOSED). |
Desired status of the service. The possible values of this field
would be PIN_STATUS_ACTIVE(10100) or PIN_STATUS_INACTIVE(10102).
Desired status flags. This indicates a reason for this service to
become inactive or closed.
| | |
| 2 | timestamp
CLOSE_WHEN_T | In Out |
Desired service close time.
| | | |
| Use | | optional |
| | | |
| Parent | | out.SERVICES |
| | | |
| ElemID mode | | ignored |
| | | |
| Iteration | | undefined |
| | | |
| Min number of Elements | | 0 |
Profiles associate with this service.
The poid of the profile object created.
| | |
| 2 | substruct
INHERITED_INFO | In Out |
Inherited info for profile object.
| | |
| 1 | substruct
INHERITED_INFO | In Out |
Inherited info for service object.
Devices array. This contains an array of device poids to be
associated with the service being created.
Poid of the device that is associated.
| | | |
| Use | | optional |
| | | |
| ElemID mode | | index |
| | | |
| Iteration | | undefined |
| | | |
| Min number of Elements | | 0 |
This represents the array of Billing info's specified.
The POID of billinfo
| | |
| 1 | poid
BUSINESS_PROFILE_OBJ | In Out |
| | | |
| Use | | optional |
| | | |
| Parent | | out.BILLINFO |
| | | |
| Class | | /config/business_profile |
Business profile poid. Pointer to the Business profile poid to which
this billinfo belongs.
| | |
| 1 | string
BILLINFO_ID | In Out |
This field identifies the billinfo by name.
| | |
| 1 | int
ACTG_CYCLE_DOM | In Out |
Billing date
The payinfo object that this billinfo is associated with.
The balance group object that this billinfo is associated with.
Flag to indicate on demand bill at the deal level and has value
PIN_DEAL_FLG_BILL_ON_DEMAND for on demand billing. Present only if
a customized deal is to be purchased.
| |
| 0 | Undefined pay type(PIN_PAY_TYPE_UNDEFINED). |
| |
| 10001 | Indicates invoice type(PIN_PAY_TYPE_INVOICE). |
| |
| 10003 | Indicates credit card type(PIN_PAY_TYPE_CC). |
| |
| 10005 | Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD). |
| |
| 10007 | Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD). |
This represents the type of billing for user.
Indicates if this billinfo has subordinates or not. A value of 0
indicates no subordinates. A value of 1 indicates that it has
subordinates.
Anniversary billing slot.
| | |
| 1 | int
ACTG_FUTURE_DOM | In Out |
New Accounting Close day-of-month (1-31).
| |
| 1 | This represents "open items" type of accounting. With open item
accounting customer's bill does not include amounts from previous
bill, if not paid(PIN_ACTG_TYPE_OPEN_ITEMS). |
| |
| 2 | This represents "balance forward" type of accounting. With balance
forward accounting customer's bill will include amounts from
previous bill, if not paid(PIN_ACTG_TYPE_BALANCE_FORWARD). |
Accounting type of the billinfo. Possible values are
PIN_ACTG_TYPE_OPEN_ITEMS(1) and PIN_ACTG_TYPE_BALANCE_FORWARD(2).This
field is used to allocate items for payment. If not specified, the
configuration entry actg_type is read from pin.conf of CM. If CM's
pin.conf does not have actg_type entry active, then default
accounting type will be balance forward type.
| | |
| 1 | enum
BILLING_STATUS | In Out |
| |
| 0 | Indicates billing status is active(PIN_BILL_ACTIVE). |
| |
| 1 | Indicates billing status is inactive(PIN_BILL_INACTIVE). |
Indicates whether the billinfo should be billed or it should be
suspended for billing.
| | |
| 1 | int
BILLING_STATUS_FLAGS | In Out |
Indicates a reason for setting of the given billing status.
| |
| 10100 | Indicates an active billinfo(PIN_STATUS_ACTIVE). |
| |
| 10102 | Indicates an inactive billinfo(PIN_STATUS_INACTIVE). |
| |
| 10103 | Indicates a closed billinfo(PIN_STATUS_CLOSED). |
Status of the billinfo: active, inactive, or closed.
It indicates a reason for setting of the given status.
It indicates whether this billinfo has a sponsoree.
| 1 | int
SPONSOREE_FLAGS | In Out |
It indicates whether this billinfo has a sponsor.
| | |
| 1 | poid
AR_BILLINFO_OBJ | In Out |
It indicates the AR billinfo for the given billinfo. It can be
present only for a subodinate billinfo.
| | |
| 1 | poid
PARENT_BILLINFO_OBJ | In Out |
It indicates the immediate (one level up) parent. Note that the given
billinfo is not necessarily a subordinate. The parent field may
reflect just child-parent relation. It should be mandatory if moving
to the new parent.
During account creation these values will be derived from the
account. In future when an account can have multiple currencies, the
value specified here will be used.
| | |
| 1 | int
CURRENCY_SECONDARY | In Out |
During account creation these values will be derived from the
account. In future when an account can have multiple currencies, the
value specified here will be used.
| | |
| 1 | enum
BILLING_SEGMENT | In Out |
It indicates the Billing Segment. A billing segment is a user defined
category such as wholesale or retail, that controls the accounting
DOMs to which a bill unit can be assigned.
| | |
| 1 | timestamp
EFFECTIVE_T | In Out |
This field represents the timestamp of effective time of the update
to this billinfo. If not specified, the current time on the Oracle Monetization Cloud
server will be used.
| | | |
| Use | | optional |
| | | |
| ElemID mode | | index |
| | | |
| Iteration | | undefined |
| | | |
| Min number of Elements | | 0 |
The Balance Group array. List of balance groups that was to be created
or updated in this operation.
The balance group POID.
Balance Group name.
The POID of Billinfo that this balance group is associated with.
The account object that this bal-info is associated with.
The service object that this bal-info is associated with.
| | | |
| Use | | optional |
| | | |
| Parent | | out.BAL_INFO |
| | | |
| ElemID mode | | index |
| | | |
| Iteration | | undefined |
| | | |
| Min number of Elements | | 0 |
This an optional array to set the credit limit parameters. The
element id is significant and indicates the resource id for which the
limit is being set.
| | |
| 2 | decimal
CREDIT_LIMIT | In Out |
Limit for this resource. Current balance cannot exceed this limit
unless affected by a limit override rate or manually adjusted by a
CSR.
| | |
| 2 | decimal
CREDIT_FLOOR | In Out |
Baseline for calculating percentage for threshold triggers. Credit
limit minus credit floor is 100% of measured range. Credit floor
does NOT enforce any limit on current balance.
| | |
| 2 | int
CREDIT_THRESHOLDS | In Out |
Bit flags for triggering when resource balance crosses a boundary
when increasing in value.
| | | |
| Use | | optional |
| | | |
| Parent | | out.BAL_INFO.LIMIT |
| | | |
| ElemID mode | | ignored |
| | | |
| Iteration | | undefined |
| | | |
|
Allow ELEMID_ASSIGN
| | true |
| | | |
| Allow ELEMID_ANY | | true |
| | | |
| Recursive | | false |
Array of fixed threshold values.
Fixed threshold value.
| | | |
| Use | | optional |
| | | |
| Parent | | out.BAL_INFO |
| | | |
| ElemID mode | | index |
| | | |
| Iteration | | undefined |
| | | |
| Min number of Elements | | 0 |
This is an optional array to set the consumption rules for a
resource. The element id is significant and indicates a resource id
for which the limit as well as consumption rules are set.
| | |
| 2 | enum
CONSUMPTION_RULE | In Out |
| |
| 0 | The consumption rule is not defined
(PIN_CONSUMPTION_RULE_UNDEFINED). |
| |
| 1 | Earliest start time. Consume the sub-balance with the earliest
validity start time (earliest valid_from) first
(PIN_CONSUMPTION_RULE_EST). |
| |
| 2 | Latest start time. Consume the sub-balance with the latest
validity start time (latest valid_from) first
(PIN_CONSUMPTION_RULE_LST). |
| |
| 3 | Earliest expiration time. Consume the sub-balance that expires
first (earliest valid_to.)(PIN_CONSUMPTION_RULE_EET) |
| |
| 4 | Latest expiration time. Consume the sub-balance that expires last
(latest valid_to.)(PIN_CONSUMPTION_RULE_LET) |
| |
| 5 | Earliest start time and latest expiration time. Consume the
sub-balance with the earliest valid_from first. If more than one
sub-balances has the same valid_from, consume the one with the
latest valid_to first(PIN_CONSUMPTION_RULE_ESTLET). |
| |
| 6 | Earliest start time and earliest expiration time. Consume the
sub-balance with the earliest valid_from first. If more than one
sub-balances has the same valid_from, consume the one with the
earliest valid_to first(PIN_CONSUMPTION_RULE_ESTEET). |
| |
| 7 | Latest start time and earliest expiration time. Consume the
sub-balance with the latest sub-balance first. If more than one
sub-balances has the same valid_from, consume the one with the
earliest expired sub-balance first(PIN_CONSUMPTION_RULE_LSTEET). |
| |
| 8 | Latest start time and latest expiration time. Consume the
sub-balance with the latest valid_from first. If more than one
sub-balances has the same valid_from, consume the one with the
latest valid_to first(PIN_CONSUMPTION_RULE_LSTLET). |
| |
| 9 | Earliest expiration time and earliest start time. Consume the
sub-balance with the earliest valid_to first. If more than one
sub-balances has the same valid_to, consume the one with the
earliest valid_from first(PIN_CONSUMPTION_RULE_EETEST). |
| |
| 10 | Earliest expiration time and latest start time. Consume the
sub-balance with the earliest valid_to first. If more than one
sub-balances has the same valid_to, consume the one with the
latest valid_from first(PIN_CONSUMPTION_RULE_EETLST). |
| |
| 11 | Latest expiration time and earliest start time. Consume the
sub-balance with the latest valid_to first. If more than one
sub-balances has the same valid_to, use the one with the earliest
valid_from first(PIN_CONSUMPTION_RULE_LETEST). |
| |
| 12 | Latest expiration time and latest start time. Consume the
sub-balance with the latest valid_to first. If more than one
sub-balances has the same valid_to, use the one with the latest
valid_from first(PIN_CONSUMPTION_RULE_LETLST). |
Consumption rule to be applied on the resource.
| | | |
| Use | | optional |
| | | |
| ElemID mode | | index |
| | | |
| Iteration | | undefined |
| | | |
| Min number of Elements | | 1 |
Array of payment methods associated with this account.
The POID of the payinfo object created or updated.
| |
| 0 | Undefined pay type(PIN_PAY_TYPE_UNDEFINED). |
| |
| 10001 | Indicates invoice type(PIN_PAY_TYPE_INVOICE). |
| |
| 10003 | Indicates credit card type(PIN_PAY_TYPE_CC). |
| |
| 10005 | Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD). |
| |
| 10007 | Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD). |
This represents the type of billing for user.
Payment term ID defines which payment term will be used in the
payment due date calculation.
| | |
| 1 | int
PAYMENT_OFFSET | In Out |
Payment Offset.
| |
| 0x01 | Indicates detail invoice(PIN_INV_TYPE_DETAIL). |
| |
| 0x02 | Indicates summary invoice(PIN_INV_TYPE_SUMMARY). |
| |
| 0x04 | Indicates regular invoice(PIN_INV_TYPE_REGULAR). |
| |
| 0x08 | Indicates subordinate invoice(PIN_INV_TYPE_SUBORDINATE). |
| |
| 0x10 | Indicates parent invoice(PIN_INV_TYPE_PARENT) |
| |
| 0x18 | Indicates parent with subordinates invoice
(PIN_INV_TYPE_PARENT_WITH_SUBORDS). |
| |
| 0x20 | Indicates hierarchy invoice(PIN_INV_TYPE_HIERARCHY). |
| |
| 0x40 | Indicates trial invoice(PIN_INV_TYPE_TRIAL_INVOICE). |
Indicates the type of invoice to be generated.
Partial Flag. This enables the operation to treat some fields
from the request as optional. Values are (0) mandatory,
or (1) optional. The fields affected are:
PIN_FLD_DEBIT_NUM, PIN_FLD_DEBIT_EXP, PIN_FLD_BANK_NO,
PIN_FLD_CITY, PIN_FLD_STATE, PIN_FLD_ZIP and PIN_FLD_COUNTRY.
| | |
| 1 | substruct
INHERITED_INFO | In Out |
All subclass fields for the payinfo object are included in this
substruct. The subclass depends on the pay_type. If pay_type is
invoice then this array element will have PIN_FLD_INV_INFO, etc.
| | | |
| Use | | optional |
| | | |
| Parent | | out.PAYINFO.INHERITED_INFO |
| | | |
| ElemID mode | | ignored |
| | | |
| Iteration | | undefined |
| | | |
| Min number of Elements | | 0 |
| | | |
| Max number of Elements | | 1 |
This array element has fields related to invoice type of payment
menthod. There will be only one element and element id is not
significant.
Street address.
City.
Country.
| | |
| 3 | string
DELIVERY_DESCR | In Out |
Delivery mechanism.
| | |
| 3 | enum
DELIVERY_PREFER | In Out |
| |
| 0 | Indicates email delivery(PIN_INV_EMAIL_DELIVERY). |
| |
| 1 | Indicates mail delivery(PIN_INV_USP_DELIVERY). |
| |
| 2 | Indicates fax delivery(PIN_INV_FAX_DELIVERY). |
Prefered delivery method email(0), postal(1) and fax(3).
Comments to appear on each invoice.
Used for invoice terms to be printed on the invoice.
Email address to which invoice be delivered.
Name of party responsible for payment.
State or province.
Zip/Postal code.
| | | |
| Use | | optional |
| | | |
| Parent | | out.PAYINFO.INHERITED_INFO |
| | | |
| ElemID mode | | ignored |
| | | |
| Iteration | | undefined |
| | | |
| Min number of Elements | | 0 |
| | | |
| Max number of Elements | | 1 |
This array element has fields related to credit card type of
payment menthod. There will be only one element and element id is
not significant.
Street Address.
City.
Country.
Credit card expiration date (mmyy).
Credit card number.
Name as it appears on the credit card.
| | |
| 3 | string
SECURITY_ID | In Out |
Security ID. Used for credit card fraud prevention. This field
stores the 3 digit CVV2 for Visa and 4 digit CID for amex.
State or province.
Zip/Postal code.
| | | |
| Use | | optional |
| | | |
| Parent | | out.PAYINFO.INHERITED_INFO |
| | | |
| ElemID mode | | ignored |
| | | |
| Iteration | | undefined |
| | | |
| Min number of Elements | | 0 |
| | | |
| Max number of Elements | | 1 |
This array element has fields related to direct debit type of
payment menthod. There will be only one element and element id is
not significant.
Street Address.
RDFI/Bank ID used for routing transactions.
City.
Country.
Customer's bank account number.
Name as it appears on the card.
State or province.
| |
| 1 | Checking Account type(PIN_ACCOUNT_TYPE_CHECKING). |
| |
| 2 | Savings Account type(PIN_ACCOUNT_TYPE_SAVINGS). |
| |
| 3 | Corporate Account type(PIN_ACCOUNT_TYPE_CORPORATE). |
Bank account type. Checking(1), savings(2) or corporate(3).
Zip/Postal code.
| | | |
| Use | | optional |
| | | |
| Parent | | out.PAYINFO.INHERITED_INFO |
| | | |
| ElemID mode | | ignored |
| | | |
| Iteration | | undefined |
| | | |
| Min number of Elements | | 0 |
| | | |
| Max number of Elements | | 1 |
This array element has fields related to SEPA type of
payment menthod. There will be only one element and element id is
not significant.
| |
| 0 | One-off mandate. |
| |
| 1 | Recurring mandate. |
Mandate type whether it is one-off or recurring.
International Bank Account Number which
is a unique identifier for the bank account.
Bank Identifier Code which is a unique
identifier for the bank related to the account.
| | |
| 3 | string
MANDATE_CONTRACT_ID | In Out |
ID of the underlying contract between the debtor
and the creditor.
| | |
| 3 | string
MANDATE_CONTRACT_DESCR | In Out |
Description of the underlying contract between the debtor
and the creditor.
| | |
| 3 | string
MANDATE_UNIQUE_REFERENCE | In Out |
A unique reference number for the mandate.
| | | |
| Use | | optional |
| | | |
| Parent | | out.PAYINFO.INHERITED_INFO.SEPA_INFO |
| | | |
| ElemID mode | | ignored |
| | | |
| Iteration | | undefined |
| | | |
| Min number of Elements | | 0 |
| | | |
| Max number of Elements | | 1 |
| | | |
| Max ID | | 0 |
| | | |
| Allowed Elem ID List | | 0 |
| | | |
|
Allow ELEMID_ASSIGN
| | false |
| | | |
| Allow ELEMID_ANY | | false |
| | | |
| Recursive | | false |
Array to store SEPA compliant customer's bank account details.
Street address of the contact.
City portion of the address.
Country portion of the address.
Name of the contact.
Zipcode.
| | |
| 4 | string
IDENTIFICATION_CODE | In Out |
Debtor identification code.
Name of the Debtor Reference Party.
| | |
| 4 | string
REF_PARTY_ID_CODE | In Out |
Identification code of the Debtor Reference Party.
| | |
| 3 | string
CREDITOR_ID | In Out |
Identification code of the Creditor.
| | |
| 3 | string
CREDITOR_NAME | In Out |
Name of the Creditor.
| | | |
| Use | | optional |
| | | |
| ElemID mode | | ignored |
| | | |
| Iteration | | undefined |
| | | |
| Min number of Elements | | 0 |
Profile array to be associated with the account.
The POID of profile object created or modified.
| | |
| 1 | substruct
INHERITED_INFO | In Out |
Inherited info for profile object.
| | | |
| Use | | optional |
| | | |
| ElemID mode | | ignored |
| | | |
| Iteration | | undefined |
| | | |
| Min number of Elements | | 0 |
Topup array.
Topup poid.
Account poid.
| | | |
| Use | | required |
| | | |
| Parent | | out.TOPUP_INFO |
| | | |
| ElemID mode | | key |
| | | |
| Iteration | | undefined |
| | | |
| Min number of Elements | | 1 |
The elemid is significant. Contents are not significant. The element
id points to the payinfo array element in the request to be used
for top-up.
The partial poid of payinfo.
| |
| 10001 | Indicates invoice type(PIN_PAY_TYPE_INVOICE). |
| |
| 10003 | Indicates credit card type(PIN_PAY_TYPE_CC). |
| |
| 10005 | Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD). |
| |
| 10007 | Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD). |
| |
| 10018 | Indicates SEPA payment type(PIN_PAY_TYPE_SEPA). |
This represents the type of billing for user.
Payment term ID defines which payment term will be used in the
payment due date calculation.
| | |
| 2 | int
PAYMENT_OFFSET | In Out |
Payment offset value.
| |
| 0x01 | Indicates detail invoice(PIN_INV_TYPE_DETAIL). |
| |
| 0x02 | Indicates summary invoice(PIN_INV_TYPE_SUMMARY). |
| |
| 0x04 | Indicates regular invoice(PIN_INV_TYPE_REGULAR). |
| |
| 0x08 | Indicates subordinate invoice(PIN_INV_TYPE_SUBORDINATE). |
| |
| 0x10 | Indicates parent invoice(PIN_INV_TYPE_PARENT). |
| |
| 0x18 | Indicates parent with subordinates invoice
(PIN_INV_TYPE_PARENT_WITH_SUBORDS). |
| |
| 0x20 | Indicates hierarchy invoice(PIN_INV_TYPE_HIERARCHY). |
| |
| 0x40 | Indicates trial invoice(PIN_INV_TYPE_TRIAL_INVOICE). |
Indicates the type of invoice to be generated.
Partial Flag. This enables the operation to treat some fields
from the request as optional. Values are (0) mandatory,
or (1) optional. The fields affected are:
PIN_FLD_DEBIT_NUM, PIN_FLD_DEBIT_EXP, PIN_FLD_BANK_NO,
PIN_FLD_CITY, PIN_FLD_STATE, PIN_FLD_ZIP and PIN_FLD_COUNTRY.
| | |
| 2 | substruct
INHERITED_INFO | In Out |
All subclass fields for the payinfo object are included in this
substruct. The subclass depends on the pay_type. If pay_type is
invoice then this array element will have PIN_FLD_INV_INFO, etc.
This array element has fields related to invoice type of payment
menthod. There will be only one element and element id is not
significant.
Street address.
City.
Country.
| | |
| 4 | string
DELIVERY_DESCR | In Out |
Delivery mechanism.
| | |
| 4 | enum
DELIVERY_PREFER | In Out |
| |
| 0 | Indicates email delivery(PIN_INV_EMAIL_DELIVERY). |
| |
| 1 | Indicates mail delivery(PIN_INV_USP_DELIVERY). |
| |
| 3 | Indicates fax delivery(PIN_INV_FAX_DELIVERY). |
Prefered delivery method email(0), postal(1) and fax(3).
Comments to appear on each invoice.
Used for invoice terms to be printed on the invoice.
Email address to which invoice be delivered.
Name of party responsible for payment.
State or province.
Zip/Postal code.
This array element has fields related to credit card type of
payment menthod. There will be only one element and element id is
not significant.
Street Address
City.
Country.
Credit card expiration date (mmyy).
Credit card number.
Name as it appears on the credit card.
| | |
| 4 | string
SECURITY_ID | In Out |
Security ID. Used for credit card fraud prevention. This field
stores the 3 digit CVV2 for Visa and 4 digit CID for amex.
State or province.
Zip/Postal code.
This array element has fields related to direct debit type of
payment menthod. There will be only one element and element id is
not significant.
Street Address.
RDFI/Bank ID used for routing transactions.
City.
Country.
Customer's bank account number.
Name as it appears on the card.
State or province.
| |
| 1 | Checking Account type(PIN_ACCOUNT_TYPE_CHECKING). |
| |
| 2 | Savings Account type(PIN_ACCOUNT_TYPE_SAVINGS). |
| |
| 3 | Corporate Account type(PIN_ACCOUNT_TYPE_CORPORATE). |
Bank account type. Checking(1), savings(2) or corporate(3).
Zip/Postal code.
This array element has fields related to SEPA type of
payment method. There will be only one element and element id is
not significant.
| |
| 0 | One-off mandate. |
| |
| 1 | Recurring mandate. |
Mandate type whether it is one-off or recurring.
International Bank Account Number which
is a unique identifier for the bank account.
Bank Identifier Code which is a unique
identifier for the bank related to the account.
| | |
| 4 | string
MANDATE_CONTRACT_ID | In Out |
ID of the underlying contract between the debtor
and the creditor.
| | |
| 4 | string
MANDATE_CONTRACT_DESCR | In Out |
Description of the underlying contract between the debtor
and the creditor.
| | |
| 4 | string
MANDATE_UNIQUE_REFERENCE | In Out |
A unique reference number for the mandate.
| | |
| 4 | timestamp
MANDATE_SIGNED_T | In Out |
Date when the mandate is signed. This cannot be before the account creation date or a future date.
| | |
| 4 | string
MANDATE_SIGNED_PLACE | In Out |
Place where the mandate is signed.
| | | |
| Use | | required |
| | | |
| Parent | | out.TOPUP_INFO.PAYINFO.INHERITED_INFO.SEPA_INFO |
| | | |
| ElemID mode | | ignored |
| | | |
| Iteration | | undefined |
| | | |
| Min number of Elements | | 0 |
| | | |
| Max number of Elements | | 1 |
| | | |
| Max ID | | 0 |
| | | |
| Allowed Elem ID List | | 0 |
| | | |
|
Allow ELEMID_ASSIGN
| | false |
| | | |
| Allow ELEMID_ANY | | false |
| | | |
| Recursive | | false |
Array to store SEPA compliant customer's bank account details.
Street address of the contact.
City portion of the address.
Country portion of the address.
Name of the contact.
Zipcode.
| | |
| 5 | string
IDENTIFICATION_CODE | In Out |
Debtor identification code.
Name of the Debtor Reference Party.
| | |
| 5 | string
REF_PARTY_ID_CODE | In Out |
Identification code of the Debtor Reference Party.
| | |
| 4 | string
CREDITOR_ID | In Out |
Identification code of the Creditor.
| | |
| 4 | string
CREDITOR_NAME | In Out |
Name of the Creditor.
| | | |
| Use | | required |
| | | |
| Parent | | out.TOPUP_INFO |
| | | |
| ElemID mode | | key |
| | | |
| Iteration | | undefined |
| | | |
| Min number of Elements | | 1 |
The elemid is significant. Contents are not significant. The element
id points to the billinfo array element in the request to be used
for top-up.
The type only billinfo poid.
| | |
| 2 | poid
BUSINESS_PROFILE_OBJ | In Out |
Business profile poid. Pointer to the Business profile poid to which
this billinfo belongs.
| | |
| 2 | string
BILLINFO_ID | In Out |
This field identifies the billinfo by name.
The Payinfo array. The element-id is significant, but not the
contents. The element-id will be used to identify which payinfo array
to use from the input. If it is not present then the payment method
is considered either as transient or voucher.
The partial poid of payinfo.
| |
| 10001 | Indicates invoice type(PIN_PAY_TYPE_INVOICE). |
| |
| 10003 | Indicates credit card type(PIN_PAY_TYPE_CC). |
| |
| 10005 | Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD). |
| |
| 10007 | Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD). |
| |
| 10018 | Indicates SEPA payment type(PIN_PAY_TYPE_SEPA). |
This represents the type of billing for user.
Payment term ID defines which payment term will be used in the
payment due date calculation.
| | |
| 3 | int
PAYMENT_OFFSET | In Out |
Payment offset value.
| |
| 0x01 | Indicates detail invoice(PIN_INV_TYPE_DETAIL). |
| |
| 0x02 | Indicates summary invoice(PIN_INV_TYPE_SUMMARY). |
| |
| 0x04 | Indicates regular invoice(PIN_INV_TYPE_REGULAR). |
| |
| 0x08 | Indicates subordinate invoice(PIN_INV_TYPE_SUBORDINATE). |
| |
| 0x10 | Indicates parent invoice(PIN_INV_TYPE_PARENT). |
| |
| 0x18 | Indicates parent with subordinates invoice
(PIN_INV_TYPE_PARENT_WITH_SUBORDS). |
| |
| 0x20 | Indicates hierarchy invoice(PIN_INV_TYPE_HIERARCHY). |
| |
| 0x40 | Indicates trial invoice(PIN_INV_TYPE_TRIAL_INVOICE). |
Indicates the type of invoice to be generated.
Partial Flag. This enables the operation to treat some fields
from the request as optional. Values are (0) mandatory,
or (1) optional. The fields affected are:
PIN_FLD_DEBIT_NUM, PIN_FLD_DEBIT_EXP, PIN_FLD_BANK_NO,
PIN_FLD_CITY, PIN_FLD_STATE, PIN_FLD_ZIP and PIN_FLD_COUNTRY.
| | |
| 3 | substruct
INHERITED_INFO | In Out |
All subclass fields for the payinfo object are included in this
substruct. The subclass depends on the pay_type. If pay_type is
invoice then this array element will have PIN_FLD_INV_INFO, etc.
This array element has fields related to invoice type of payment
menthod. There will be only one element and element id is not
significant.
Street address.
City.
Country.
| | |
| 5 | string
DELIVERY_DESCR | In Out |
Delivery mechanism.
| | |
| 5 | enum
DELIVERY_PREFER | In Out |
| |
| 0 | Indicates email delivery(PIN_INV_EMAIL_DELIVERY). |
| |
| 1 | Indicates mail delivery(PIN_INV_USP_DELIVERY). |
| |
| 3 | Indicates fax delivery(PIN_INV_FAX_DELIVERY). |
Prefered delivery method email(0), postal(1) and fax(3).
Comments to appear on each invoice.
Used for invoice terms to be printed on the invoice.
Email address to which invoice be delivered.
Name of party responsible for payment.
State or province.
Zip/Postal code.
This array element has fields related to credit card type of
payment menthod. There will be only one element and element id is
not significant.
Street Address
City.
Country.
Credit card expiration date (mmyy).
Credit card number.
Name as it appears on the credit card.
| | |
| 5 | string
SECURITY_ID | In Out |
Security ID. Used for credit card fraud prevention. This field
stores the 3 digit CVV2 for Visa and 4 digit CID for amex.
State or province.
Zip/Postal code.
This array element has fields related to direct debit type of
payment menthod. There will be only one element and element id is
not significant.
Street Address.
RDFI/Bank ID used for routing transactions.
City.
Country.
Customer's bank account number.
Name as it appears on the card.
State or province.
| |
| 1 | Checking Account type(PIN_ACCOUNT_TYPE_CHECKING). |
| |
| 2 | Savings Account type(PIN_ACCOUNT_TYPE_SAVINGS). |
| |
| 3 | Corporate Account type(PIN_ACCOUNT_TYPE_CORPORATE). |
Bank account type. Checking(1), savings(2) or corporate(3).
Zip/Postal code.
This array element has fields related to SEPA type of
payment method. There will be only one element and element id is
not significant.
| |
| 0 | One-off mandate. |
| |
| 1 | Recurring mandate. |
Mandate type whether it is one-off or recurring.
International Bank Account Number which
is a unique identifier for the bank account.
Bank Identifier Code which is a unique
identifier for the bank related to the account.
| | |
| 5 | string
MANDATE_CONTRACT_ID | In Out |
ID of the underlying contract between the debtor
and the creditor.
| | |
| 5 | string
MANDATE_CONTRACT_DESCR | In Out |
Description of the underlying contract between the debtor
and the creditor.
| | |
| 5 | string
MANDATE_UNIQUE_REFERENCE | In Out |
A unique reference number for the mandate.
| | |
| 5 | timestamp
MANDATE_SIGNED_T | In Out |
Date when the mandate is signed. This cannot be before the account creation date or a future date.
| | |
| 5 | string
MANDATE_SIGNED_PLACE | In Out |
Place where the mandate is signed.
Array to store SEPA compliant customer's bank account details.
Street address of the contact.
City portion of the address.
Country portion of the address.
Name of the contact.
Zipcode.
| | |
| 6 | string
IDENTIFICATION_CODE | In Out |
Debtor identification code.
Name of the Debtor Reference Party.
| | |
| 6 | string
REF_PARTY_ID_CODE | In Out |
Identification code of the Debtor Reference Party.
| | |
| 5 | string
CREDITOR_ID | In Out |
Identification code of the Creditor.
| | |
| 5 | string
CREDITOR_NAME | In Out |
Name of the Creditor.
| | | |
| Use | | optional |
| | | |
| Parent | | out.TOPUP_INFO.BILLINFO |
| | | |
| ElemID mode | | key |
| | | |
| Iteration | | undefined |
| | | |
| Min number of Elements | | 0 |
| | | |
| Max number of Elements | | 1 |
The balance group info array. The element-id is significant, but not
the contents. The element-id will be used to identify which balance
group array to use from the input. If it is not present then a
default balance group will be created for the billinfo.
The partial poid of the balance group to be created. During monitor
creation/update, Poid type of /balance_group/monitor is used.
Balance Group name.
The billinfo array element. Here the contents are not significant.
The element id will determine the billinfo that will be associated
with this balance group. if not specified then the first billinfo
that the system finds will be associated with this balance group.
The POID of Billinfo that this balance group will be associated with.
The fields PIN_FLD_BILLINFO and PIN_FLD_BILLINFO_OBJ are mutually
exclusive. If PIN_FLD_BILLINFO is available then PIN_FLD_BILLINFO_OBJ
will be ignored.
This an optional array to set the credit limit parameters. The
element id is significant and indicates the resource id for which the
limit is being set.
| | |
| 4 | decimal
CREDIT_LIMIT | In Out |
Limit for this resource. Current balance cannot exceed this limit
unless affected by a limit override rate or manually adjusted by a
CSR.
| | |
| 4 | decimal
CREDIT_FLOOR | In Out |
Baseline for calculating percentage for threshold triggers. Credit
limit minus credit floor is 100% of measured range. Credit floor
does NOT enforce any limit on current balance.
| | |
| 4 | decimal
CREDIT_THRESHOLDS_FIXED | In Out |
Limit for this resource. Current balance cannot exceed this limit
unless affected by a limit override rate or manually adjusted by a
CSR.
| | |
| 4 | int
CREDIT_THRESHOLDS | In Out |
Bit flags for triggering when resource balance crosses a boundary
when increasing in value.
Array of fixed threshold values.
Fixed threshold value.
Fixed threshold value in Decimal data type
This is an optional array to set the consumption rules for a
resource. The element id is significant and indicates a resource id
for which the limit as well as consumption rules are set.
| | |
| 4 | enum
CONSUMPTION_RULE | In Out |
| |
| 0 | The consumption rule is not defined
(PIN_CONSUMPTION_RULE_UNDEFINED). |
| |
| 1 | Earliest start time. Consume the sub-balance with the earliest
validity start time (earliest valid_from) first
(PIN_CONSUMPTION_RULE_EST). |
| |
| 2 | Latest start time. Consume the sub-balance with the latest
validity start time (latest valid_from) first
(PIN_CONSUMPTION_RULE_LST). |
| |
| 3 | Earliest expiration time. Consume the sub-balance that expires
first (earliest valid_to.)(PIN_CONSUMPTION_RULE_EET) |
| |
| 4 | Latest expiration time. Consume the sub-balance that expires last
(latest valid_to.)(PIN_CONSUMPTION_RULE_LET) |
| |
| 5 | Earliest start time and latest expiration time. Consume the
sub-balance with the earliest valid_from first. If more than one
sub-balances has the same valid_from, consume the one with the
latest valid_to first(PIN_CONSUMPTION_RULE_ESTLET). |
| |
| 6 | Earliest start time and earliest expiration time. Consume the
sub-balance with the earliest valid_from first. If more than one
sub-balances has the same valid_from, consume the one with the
earliest valid_to first(PIN_CONSUMPTION_RULE_ESTEET). |
| |
| 7 | Latest start time and earliest expiration time. Consume the
sub-balance with the latest sub-balance first. If more than one
sub-balances has the same valid_from, consume the one with the
earliest expired sub-balance first(PIN_CONSUMPTION_RULE_LSTEET).
|
| |
| 8 | Latest start time and latest expiration time. Consume the
sub-balance with the latest valid_from first. If more than one
sub-balances has the same valid_from, consume the one with the
latest valid_to first(PIN_CONSUMPTION_RULE_LSTLET). |
| |
| 9 | Earliest expiration time and earliest start time. Consume the
sub-balance with the earliest valid_to first. If more than one
sub-balances has the same valid_to, consume the one with the
earliest valid_from first(PIN_CONSUMPTION_RULE_EETEST). |
| |
| 10 | Earliest expiration time and latest start time. Consume the
sub-balance with the earliest valid_to first. If more than one
sub-balances has the same valid_to, consume the one with the
latest valid_from first(PIN_CONSUMPTION_RULE_EETLST). |
| |
| 11 | Latest expiration time and earliest start time. Consume the
sub-balance with the latest valid_to first. If more than one
sub-balances has the same valid_to, use the one with the earliest
valid_from first(PIN_CONSUMPTION_RULE_LETEST). |
| |
| 12 | Latest expiration time and latest start time. Consume the
sub-balance with the latest valid_to first. If more than one
sub-balances has the same valid_to, use the one with the latest
valid_from first(PIN_CONSUMPTION_RULE_LETLST). |
Consumption rule to be applied on the resource.
| |
| 10001 | Indicates invoice type(PIN_PAY_TYPE_INVOICE). |
| |
| 10003 | Indicates credit card type(PIN_PAY_TYPE_CC). |
| |
| 10005 | Indicates US/Canadian Direct Debit type(PIN_PAY_TYPE_DD). |
| |
| 10007 | Indicates charge roll up to parent account(PIN_PAY_TYPE_SUBORD). |
| |
| 10018 | |
| |
| 10101 | . |
This represents the type of billing for user.
This flag indicates if this billinfo has subordinates or not. A value
of 0 indicates no subordinates and a value of 1 indicates that it has
subordinates.
Anniversary billing slot.
| | |
| 2 | int
ACTG_FUTURE_DOM | In Out |
New Accounting Close day-of-month (1-31).
| |
| 1 | This represents "open items" type of accounting. With open item
accounting customer's bill does not include amounts from previous
bill, if not paid(PIN_ACTG_TYPE_OPEN_ITEMS). |
| |
| 2 | This represents "balance forward" type of accounting. With balance
forward accounting customer's bill will include amounts from
previous bill, if not paid(PIN_ACTG_TYPE_BALANCE_FORWARD). |
Accounting type of the billinfo. Possible values are
PIN_ACTG_TYPE_OPEN_ITEMS(1) and PIN_ACTG_TYPE_BALANCE_FORWARD(2).This
field is used to allocate items for payment. If not specified, the
configuration entry actg_type is read from pin.conf of CM. If CM's
pin.conf does not have actg_type entry active, then default
accounting type will be balance forward type.
| | |
| 2 | enum
BILLING_STATUS | In Out |
| |
| 0 | Indicates billing status is active(PIN_BILL_ACTIVE). |
| |
| 1 | Indicates billing status is inactive(PIN_BILL_INACTIVE). |
Indicates whether the billinfo should be billed or it should be
suspended for billing.
| | |
| 2 | int
BILLING_STATUS_FLAGS | In Out |
Indicates a reason for setting of the given billing status.
| |
| 10100 | Indicates an active billinfo(PIN_STATUS_ACTIVE). |
| |
| 10102 | Indicates an inactive billinfo(PIN_STATUS_INACTIVE). |
| |
| 10103 | Indicates a closed billinfo(PIN_STATUS_CLOSED). |
Status of the billinfo: active, inactive, or closed.
Indicates a reason for setting of the given status.
It indicates whether this billinfo has a sponsoree.
| 2 | int
SPONSOREE_FLAGS | In Out |
It indicates whether this billinfo has a sponsor.
| | |
| 2 | poid
AR_BILLINFO_OBJ | In Out |
It indicates the AR billinfo for the given billinfo. It can be
present only for a subodinate billinfo.
| | |
| 2 | poid
PARENT_BILLINFO_OBJ | In Out |
It indicates the immediate (one level up) parent. Note that the given
billinfo is not necessarily a subordinate. The parent field may
reflect just child-parent relation. It should be mandatory if moving
to the new parent.
During account creation these values will be derived from the
account. In future when an account can have multiple currencies, the
value specified here will be used.
| | |
| 2 | int
CURRENCY_SECONDARY | In Out |
During account creation these values will be derived from the
account. In future when an account can have multiple currencies, the
value specified here will be used.
| | |
| 2 | enum
BILLING_SEGMENT | In Out |
It indicates the Billing Segment. A billing segment is a user defined
category such as wholesale or retail, that controls the accounting
DOMs to which a bill unit can be assigned.
The payinfo object that this topup is associated with. If
PIN_FLD_PAYINFO is passed in, this field will be ignored. If
PIN_FLD_PAYINFO is not passed in, this becomes a mandatory field.
The POID of Billinfo that this topup is associated with. If
PIN_FLD_BILLINFO is passed in, this field will be ignored. If
PIN_FLD_BILLINFO is not passed in, this becomes a mandatory field.
Topup amount. In case of auto-topups this will indicate the amount to
topup with.
Topup cap. This amount indicates the max topup that can be done for a
given cycle. The cycle is driven by the cycle information set-up in
the billinfo. A values of 0 means no cap.
| | |
| 1 | decimal
CYCLE_TOPPED_AMT | In Out |
This indicates the total topped up amount during the given cycle.
This amount will be populated only if the cap is set.
| | |
| 1 | timestamp
LAST_TOPUP_T | In Out |
This indicates the when the last topup happened.
| | |
| 1 | array
GROUP_TOPUP_INFO | In Out |
| | | |
| Use | | optional |
| | | |
| Parent | | out.TOPUP_INFO |
| | | |
| ElemID mode | | ignored |
| | | |
| Iteration | | undefined |
| | | |
| Min number of Elements | | 0 |
The field represents sponsored topup. The array contains fields
related to Sponsored topup only.
The /group/topup poid. Poid of sponsored topup group involved in
the creation/modification of member account.
Parent's account poid
The Name of the /group/topup. This helps to identify the group.
Balance Group of the parent/payer of the /group/topup
| | |
| 2 | array
GROUP_TOPUP_LIMITS | In Out |
Represents /group/topup financial properties per resource id.
Resource id of topup operation.
Topup amount is used in automatic sponsored topup.
Topup cap is used as a maximum limit of topup for particular
topup group during cycle.
| | |
| 2 | array
GROUP_TOPUP_MEMBERS | In Out |
Represents members' properties of the /group/topup.
Balance Group of a member of the /group/topup.
| | |
| 3 | int
TOPUP_INTERVAL | In Out |
This indicates the interval at which automatic sponsored topup
occur.
The PIN which will be used for authentication during Ad-Hoc topup.
| |
| 10100 | Indicates an active member(PIN_STATUS_ACTIVE). |
| |
| 10102 | Indicates an inactive member(PIN_STATUS_INACTIVE). |
| |
| 10103 | Indicates a closed member(PIN_STATUS_CLOSED). |
The status of the member (active/inactive/closed).
| | |
| 0 | substruct
CONTEXT_INFO | In Out |
Substruct to pass information from external clients.
| | |
| 1 | string
CORRELATION_ID | In Out |
Correlation id passed by an external system to Oracle Monetization Cloud.
| | |
| 1 | string
EXTERNAL_USER | In Out |
User of an external system connecting to Oracle Monetization Cloud.